Skip to content

Remove workaround for sphinx cache warning #533

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
May 6, 2024
Merged

Remove workaround for sphinx cache warning #533

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c2e34e
Remove workaround for sphinx cache warning
greschd Apr 29, 2024
5fc1e8d
Merge branch 'main' into maint/remove_conf_py_cache_workaround
greschd May 6, 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
9 changes: 1 addition & 8 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
pyansys_logo_black,
watermark,
)
from sphinx_gallery.sorting import FileNameSortKey

from ansys.acp.core import __version__

Expand Down Expand Up @@ -141,12 +140,6 @@
("py:class", r"ansys\.acp.core\..*\.ScalarDataT"),
]

# The 'sphinx_gallery_conf' configuration value is not picklable, which makes
# the configuration cache fail.
# It should be possible to remove this when https://github.com/sphinx-gallery/sphinx-gallery/issues/1286
# is resolved.
suppress_warnings = ["config.cache"]

# sphinx_autodoc_typehints configuration
typehints_defaults = "comma"
simplify_optional_unions = True
Expand Down Expand Up @@ -192,7 +185,7 @@
# Remove the "Download all examples" button from the top level gallery
"download_all_examples": False,
# Sort gallery example by filename instead of number of lines (default)
"within_subsection_order": FileNameSortKey,
"within_subsection_order": "FileNameSortKey",
# directory where function granular galleries are stored
"backreferences_dir": None,
# Modules for which function level galleries are created. In
Expand Down