Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Change docs theme to PyData Sphinx theme #2513

Merged
merged 5 commits into from
Jun 7, 2024
Merged

docs: Change docs theme to PyData Sphinx theme #2513

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
141215b
Change docs theme to PyData Sphinx theme
melissawm Jun 5, 2024
a9bfd2f
Restore Python API to top navbar
melissawm Jun 7, 2024
f8410de
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jun 7, 2024
4636411
docs: Add Melissa Weber Mendonça to contributors list
matthewfeickert Jun 7, 2024
36c270c
docs: Reorder nav bar to emphasize API reference
matthewfeickert Jun 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -243,13 +242,13 @@ 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
# 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 = []
Expand Down
1 change: 1 addition & 0 deletions docs/contributors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,4 @@ Contributors include:
- Daniel Werner
- Jonas Rembser
- Lorenz Gaertner
- Melissa Weber Mendonça
13 changes: 4 additions & 9 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,20 @@

intro
likelihood
learn
examples
outreach
api
cli
installation
development
faq
learn
babel
cli
api
outreach
citations
governance/ROADMAP
release-notes
contributors

.. raw:: html

<a class="github-fork-ribbon right-top fixed" href="https://github.com/scikit-hep/pyhf/" data-ribbon="View me on GitHub" title="View me on GitHub">View me on GitHub</a>


.. raw:: html

<p id="dev-version"><strong>Warning:</strong> This is a development version. The latest stable version is at <a href="https://pyhf.readthedocs.io/">ReadTheDocs</a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down