From 18564356c30af655d9d19f0fdbd95f448131538e Mon Sep 17 00:00:00 2001 From: "Soren I. Bjornstad" Date: Sun, 15 Oct 2023 22:06:31 -0500 Subject: [PATCH] add RTD requirements.txt --- .readthedocs.yaml | 6 +++--- cli_docs/conf.py | 9 +-------- cli_docs/requirements.txt | 4 ++++ 3 files changed, 8 insertions(+), 11 deletions(-) create mode 100644 cli_docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d162996..262aa74 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -30,6 +30,6 @@ sphinx: # Optional but recommended, declare the Python requirements required # to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -# python: -# install: -# - requirements: docs/requirements.txt +python: + install: + - requirements: cli_docs/requirements.txt diff --git a/cli_docs/conf.py b/cli_docs/conf.py index cf5131a..45a428c 100644 --- a/cli_docs/conf.py +++ b/cli_docs/conf.py @@ -24,7 +24,7 @@ release = "0.4.0" # If your documentation needs a minimal Sphinx version, state it here. # -needs_sphinx = '1.8.5' +needs_sphinx = '3.5.4' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom @@ -49,13 +49,6 @@ source_suffix = '.rst' # The master toctree document. master_doc = 'index' -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - # 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. diff --git a/cli_docs/requirements.txt b/cli_docs/requirements.txt new file mode 100644 index 0000000..8f6a01e --- /dev/null +++ b/cli_docs/requirements.txt @@ -0,0 +1,4 @@ +# docs +sphinx==3.5.4 # newer versions display function names in the wrong color? +sphinx_rtd_theme==0.5.2 +Jinja2<3.1 # https://github.com/readthedocs/readthedocs.org/issues/9038