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.

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

Switch to pydata sphinx theme #422

Merged
merged 3 commits into from
Sep 26, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 7 additions & 8 deletions docs/environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@ channels:
- conda-forge
- nodefaults
dependencies:
- python=3.8
- sphinx>=1.8
- python=3.10
- jsx-lexer
- sphinx>=5.0
- sphinx-copybutton
- sphinx_rtd_theme
- pydata-sphinx-theme
- myst-parser
- pytest
- pytest-check-links
- requests-cache
- pip
- nodejs
- pip:
- jsx-lexer
- pytest-check-links[cache]>=0.4.3
- myst_parser
- requests_cache
17 changes: 4 additions & 13 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@
'myst_parser',
'sphinx.ext.intersphinx',
'sphinx.ext.mathjax',
'sphinx_copybutton'
'sphinx_copybutton',

]

myst_enable_extensions = ["html_image"]
Expand Down Expand Up @@ -156,9 +157,7 @@ def build_examples(out_dir):
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
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
Expand All @@ -176,15 +175,7 @@ def build_examples(out_dir):
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
'donate.html',
]
}
# html_sidebars = {}

# Output for github to be used in links
html_context = {
Expand Down