From 439cbf83916045bf96c87164ff5f20c4f67f20a8 Mon Sep 17 00:00:00 2001 From: Juergen Repp Date: Thu, 5 Dec 2024 20:52:57 +0100 Subject: [PATCH] readthedocs: fix requirements * The list of required packages is extended. * A handler to fix wrong html generation of index.html is added. Signed-off-by: Juergen Repp --- sphinx/conf.py | 23 +++++++++++++++++++++++ sphinx/requirements.txt | 12 ++++++++++++ 2 files changed, 35 insertions(+) diff --git a/sphinx/conf.py b/sphinx/conf.py index 9235b35dd..69843bba3 100644 --- a/sphinx/conf.py +++ b/sphinx/conf.py @@ -14,6 +14,7 @@ # serve to show the default. import subprocess +import os # Create (unused) root file with open("index.rst", "w") as index_rst: @@ -306,3 +307,25 @@ # If true, do not generate a @detailmenu in the "Top" node's menu. # texinfo_no_detailmenu = False + +# -- Extension configuration ------------------------------------------------- + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + + +def builder_finished_handler(app, exception): + if exception is None: + os.environ["SPHINX_OUTDIR"] = str(app.outdir) + script = os.path.join(app.confdir, "sphinx-finished.sh") + subprocess.check_call(script, shell=True) + + +# +# Hook the setup of readthedocs so we can hook into events as defined in: +# - https://www.sphinx-doc.org/en/master/extdev/appapi.html +# +def setup(app): + app.connect("build-finished", builder_finished_handler) diff --git a/sphinx/requirements.txt b/sphinx/requirements.txt index 28c2bdaab..7d2e88c43 100644 --- a/sphinx/requirements.txt +++ b/sphinx/requirements.txt @@ -1,3 +1,15 @@ +setuptools_scm[toml]>=3.4.3 +cffi>=1.0.0 +pkgconfig +cryptography>=3.0 +asn1crypto +packaging +pycparser +cffi>=1.0.0 +asn1crypto +cryptography>=3.0 +packaging +pyyaml # needed for readthedocs builds: GitPython myst_parser