From 141215bb3032d7fee806136c753dcbb7da244e63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Melissa=20Weber=20Mendon=C3=A7a?= Date: Tue, 4 Jun 2024 17:53:45 -0700 Subject: [PATCH 1/5] Change docs theme to PyData Sphinx theme --- docs/conf.py | 3 +-- docs/index.rst | 5 ----- pyproject.toml | 2 +- 3 files changed, 2 insertions(+), 8 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 132f4da544..2eb7d467ec 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,7 +55,6 @@ def setup(app): 'sphinx.ext.viewcode', 'sphinx.ext.githubpages', 'sphinx.ext.intersphinx', - 'sphinx_rtd_theme', 'sphinxcontrib.bibtex', 'sphinx.ext.napoleon', 'sphinx_click.ext', @@ -243,7 +242,7 @@ def setup(app): # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' +html_theme = 'pydata_sphinx_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/docs/index.rst b/docs/index.rst index fbb5bf9925..4f71a891aa 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -22,11 +22,6 @@ release-notes contributors -.. raw:: html - - View me on GitHub - - .. raw:: html

Warning: This is a development version. The latest stable version is at ReadTheDocs.

diff --git a/pyproject.toml b/pyproject.toml index 6b53e2b5bc..52ae121b8f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -118,7 +118,7 @@ docs = [ "sphinx>=7.0.0", # c.f. https://github.com/scikit-hep/pyhf/pull/2271 "sphinxcontrib-bibtex>=2.1", "sphinx-click", - "sphinx-rtd-theme>=1.3.0", # c.f. https://github.com/scikit-hep/pyhf/pull/2271 + "pydata-sphinx-theme>=0.15.3", "nbsphinx!=0.8.8", # c.f. https://github.com/spatialaudio/nbsphinx/issues/620 "ipywidgets", "sphinx-issues", From a9bfd2f151f2f03848d071559a7db8aef49f4e41 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Melissa=20Weber=20Mendon=C3=A7a?= Date: Thu, 6 Jun 2024 17:47:45 -0700 Subject: [PATCH 2/5] Restore Python API to top navbar --- docs/conf.py | 4 +++- docs/index.rst | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 2eb7d467ec..1ffacf2f3a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -248,7 +248,9 @@ def setup(app): # further. For a list of options available for each theme, see the # documentation. # -html_theme_options = {} +html_theme_options = { + "header_links_before_dropdown": 6 +} # Add any paths that contain custom themes here, relative to this directory. html_theme_path = [] diff --git a/docs/index.rst b/docs/index.rst index 4f71a891aa..f0fb74b0fa 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,12 +11,12 @@ learn examples outreach + api installation development faq babel cli - api citations governance/ROADMAP release-notes From f8410dea7ea2e4bcd27d078150a3af35e904454a Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Fri, 7 Jun 2024 00:48:14 +0000 Subject: [PATCH 3/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/conf.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 1ffacf2f3a..801ef81cef 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -248,9 +248,7 @@ def setup(app): # further. For a list of options available for each theme, see the # documentation. # -html_theme_options = { - "header_links_before_dropdown": 6 -} +html_theme_options = {"header_links_before_dropdown": 6} # Add any paths that contain custom themes here, relative to this directory. html_theme_path = [] From 4636411a39905aa00d1a9f2eb84866d9bc22ff4f Mon Sep 17 00:00:00 2001 From: Matthew Feickert Date: Fri, 7 Jun 2024 02:12:04 -0500 Subject: [PATCH 4/5] =?UTF-8?q?docs:=20Add=20Melissa=20Weber=20Mendon?= =?UTF-8?q?=C3=A7a=20to=20contributors=20list?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/contributors.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/contributors.rst b/docs/contributors.rst index d29fd0974b..292efde1c7 100644 --- a/docs/contributors.rst +++ b/docs/contributors.rst @@ -34,3 +34,4 @@ Contributors include: - Daniel Werner - Jonas Rembser - Lorenz Gaertner +- Melissa Weber Mendonça From 36c270cf31541bdaa5648bd203f8f75bf227813b Mon Sep 17 00:00:00 2001 From: Matthew Feickert Date: Fri, 7 Jun 2024 02:32:04 -0500 Subject: [PATCH 5/5] docs: Reorder nav bar to emphasize API reference --- docs/index.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index f0fb74b0fa..7bddc7b269 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,15 +8,15 @@ intro likelihood - learn examples - outreach api + cli installation development faq + learn babel - cli + outreach citations governance/ROADMAP release-notes