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

Jump to bottom

Fix docs build #2589

Merged
merged 1 commit into from
Jul 15, 2024
Merged

Fix docs build #2589

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
11 changes: 6 additions & 5 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
import sys
from pathlib import Path

from sphinx_gallery.sorting import ExplicitOrder, FileNameSortKey
from sphinx_gallery.sorting import ExplicitOrder

import ctapipe

Expand Down Expand Up @@ -177,7 +177,7 @@ def setup(app):
"../examples/visualization",
]
),
"within_subsection_order": FileNameSortKey,
"within_subsection_order": "FileNameSortKey",
"nested_sections": False,
"filename_pattern": r".*\.py",
"copyfile_regex": r".*\.png",
Expand Down Expand Up @@ -205,7 +205,6 @@ def setup(app):
# have all links automatically associated with the right domain.
default_role = "py:obj"

suppress_warnings = ["ref.citation"] # ignore citation not referenced warnings

# General information about the project.

Expand Down Expand Up @@ -414,8 +413,10 @@ def setup(app):
}


# workaround for sphinx-gallery-conf not being cacheable and warning resulting in docs failure
suppress_warnings = ["config.cache"]
# workaround for ipywidgets and sklearn having duplicate definitions in intersphinx
suppress_warnings = [
"intersphinx.external",
]

bibtex_bibfiles = ["references.bib"]
bibtex_encoding = "utf8"
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 @@ -68,7 +68,7 @@ docs = [
"nbsphinx",
"numpydoc",
"sphinx-design",
"sphinx-gallery",
"sphinx-gallery >= 0.16.0",
"sphinxcontrib-bibtex",
"jupyter",
"notebook",
Expand Down