Skip to content

Sphinx reset modules #4885

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

Merged
merged 2 commits into from
Aug 1, 2022
Merged

Sphinx reset modules #4885

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a3d098
fix sphinx-gallery
bjlittle Aug 1, 2022
4b8f7a0
change gallery index reference
bjlittle Aug 1, 2022
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: 5 additions & 0 deletions docs/src/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -368,6 +368,11 @@ def _dotv(version):
"ignore_pattern": r"__init__\.py",
# force gallery building, unless overridden (see src/Makefile)
"plot_gallery": "'True'",
# force re-registering of nc-time-axis with matplotlib for each example,
# required for sphinx-gallery>=0.11.0
"reset_modules": (
lambda gallery_conf, fname: sys.modules.pop("nc_time_axis", None),
),
}

# -----------------------------------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/src/developers_guide/contributing_documentation_full.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ can exclude the module from the API documentation. Add the entry to the
Gallery
~~~~~~~

The Iris :ref:`sphx_glr_generated_gallery` uses a sphinx extension named
The Iris :ref:`gallery_index` uses a sphinx extension named
`sphinx-gallery <https://sphinx-gallery.github.io/stable/>`_
that auto generates reStructuredText (rst) files based upon a gallery source
directory that abides directory and filename convention.
Expand Down
2 changes: 1 addition & 1 deletion requirements/ci/py310.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,6 @@ dependencies:
- sphinx
- sphinxcontrib-napoleon
- sphinx-copybutton
- sphinx-gallery
- sphinx-gallery >=0.11.0
- sphinx-panels
- pydata-sphinx-theme = 0.8.1
2 changes: 1 addition & 1 deletion requirements/ci/py38.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,6 @@ dependencies:
- sphinx
- sphinxcontrib-napoleon
- sphinx-copybutton
- sphinx-gallery
- sphinx-gallery >=0.11.0
- sphinx-panels
- pydata-sphinx-theme = 0.8.1
2 changes: 1 addition & 1 deletion requirements/ci/py39.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,6 @@ dependencies:
- sphinx
- sphinxcontrib-napoleon
- sphinx-copybutton
- sphinx-gallery
- sphinx-gallery >=0.11.0
- sphinx-panels
- pydata-sphinx-theme = 0.8.1
2 changes: 1 addition & 1 deletion setup.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ where = lib
docs =
sphinx
sphinx-copybutton
sphinx-gallery
sphinx-gallery>=0.11.0
sphinx_rtd_theme
sphinxcontrib-napoleon
sphinx-panels
Expand Down