Skip to content

ENH: split doc generation to avoid sphinx-design requiring nonnewest … #1113

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

Closed
wants to merge 1 commit into from
Closed

ENH: split doc generation to avoid sphinx-design requiring nonnewest … #1113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
# -- Project information -----------------------------------------------------

project = "PyData Theme"
copyright = "2019, PyData Community"
copyright = "2023, PyData Community"
author = "PyData Community"

import pydata_sphinx_theme
Expand Down
13 changes: 8 additions & 5 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ classifiers = [
]

[project.optional-dependencies]
doc = [
doc_base = [
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one comment: the failing tests are because only half of the packages are installed as long as there is no version released with the changes:

WARNING: pydata-sphinx-theme 0.12.1rc1.dev0 does not provide the extra 'doc-base'

"numpydoc",
"myst-nb",
"linkify-it-py", # for link shortening
Expand All @@ -61,22 +61,25 @@ doc = [
"numpy",
"xarray",
"sphinx-copybutton",
"sphinx-design",
"sphinx-togglebutton",
"ipyleaflet",
]
doc = [
"sphinx-design",
# Install nbsphinx in case we want to test it locally even though we can't load
# it at the same time as MyST-NB.
"nbsphinx",
"ipyleaflet",
"pydata-sphinx-theme[doc_base]"
]
test = [
"pytest",
"pydata-sphinx-theme[doc]",
"pydata-sphinx-theme[doc_base]",
]
coverage = [
"pytest-cov",
"codecov",
"colorama",
"pydata-sphinx-theme[test]",
"pydata-sphinx-theme[doc]",
]
dev = [
"pyyaml",
Expand Down