From 42dbfcf2c45f38a004a1f576dad38e7ad5d554cb Mon Sep 17 00:00:00 2001 From: Mike Edmunds Date: Fri, 25 Aug 2023 12:19:05 -0700 Subject: [PATCH] Docs: fix RTD Sphinx build, update deps --- docs/_readme/template.txt | 8 ++++---- docs/conf.py | 11 +++-------- docs/requirements.txt | 9 ++++----- 3 files changed, 11 insertions(+), 17 deletions(-) diff --git a/docs/_readme/template.txt b/docs/_readme/template.txt index 00695286..c3423fb8 100644 --- a/docs/_readme/template.txt +++ b/docs/_readme/template.txt @@ -1,6 +1,6 @@ %(head_prefix)s - - - + + + diff --git a/docs/conf.py b/docs/conf.py index 41e07185..820249df 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -31,7 +31,7 @@ # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ["sphinx.ext.intersphinx", "sphinx.ext.extlinks"] +extensions = ["sphinx.ext.intersphinx", "sphinx.ext.extlinks", "sphinx_rtd_theme"] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] @@ -98,12 +98,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -if not ON_READTHEDOCS: # only import and set the theme if we're building docs locally - import sphinx_rtd_theme # this seems to come with sphinx; if not, pip install it - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] -# else readthedocs.org uses their theme by default (and specifying it here breaks them) +html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -261,7 +256,7 @@ # -- Options for extlinks --------------------------------------------------- extlinks = { - "pypi": ("https://pypi.org/project/%s/", ""), + "pypi": ("https://pypi.org/project/%s/", "%s"), } # -- Options for Intersphinx ------------------------------------------------ diff --git a/docs/requirements.txt b/docs/requirements.txt index ea25bfff..949a9e3b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,7 +1,6 @@ # Packages required only for building docs -# (Pygments defaulted "python" to Python 2 before v2.5.0; it doesn't use semver) -Pygments~=2.9.0 -readme-renderer~=37.3 -sphinx~=4.0 -sphinx-rtd-theme~=0.5.2 +Pygments~=2.16.1 +readme-renderer~=41.0 +sphinx~=7.2 +sphinx-rtd-theme~=1.3.0