Skip to content

Commit

Permalink
Merge pull request #2589 from cta-observatory/fix_intersphinx_warning
Browse files Browse the repository at this point in the history
Fix docs build
  • Loading branch information
maxnoe authored Jul 15, 2024
2 parents 970300e + a03164c commit 2fec8ca
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
11 changes: 6 additions & 5 deletions docs/conf.py
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
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

0 comments on commit 2fec8ca

Please sign in to comment.