From a03164c54190edec074931ad6b4919d8f52a4079 Mon Sep 17 00:00:00 2001 From: Maximilian Linhoff Date: Mon, 15 Jul 2024 14:07:11 +0200 Subject: [PATCH] Fix docs build --- docs/conf.py | 11 ++++++----- pyproject.toml | 2 +- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 6f38cc54bee..e302a8c3e0c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 @@ -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", @@ -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. @@ -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" diff --git a/pyproject.toml b/pyproject.toml index ac7611797ea..39e9101ea37 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -68,7 +68,7 @@ docs = [ "nbsphinx", "numpydoc", "sphinx-design", - "sphinx-gallery", + "sphinx-gallery >= 0.16.0", "sphinxcontrib-bibtex", "jupyter", "notebook",