From d1e61e25f46cfdd045f685c21d16095e54667de8 Mon Sep 17 00:00:00 2001 From: Peter Briggs Date: Fri, 16 Feb 2024 16:10:27 +0000 Subject: [PATCH 1/3] Add top-level 'requirements.txt' file. --- requirements.txt | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 requirements.txt diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..581ae10 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +xlwt>=0.7.2 +xlrd>=0.7.1 +xlutils>=1.4.1 +xlsxwriter>=0.8.4 From d934f476ae0c3f5c9d15a9e933879143b3575769 Mon Sep 17 00:00:00 2001 From: Peter Briggs Date: Fri, 16 Feb 2024 16:11:04 +0000 Subject: [PATCH 2/3] Add .readthedocs.yaml file and documentation-specific requirements.txt file. --- .readthedocs.yaml | 17 +++++++++++++++++ docs/requirements.txt | 3 +++ 2 files changed, 20 insertions(+) create mode 100644 .readthedocs.yaml create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..8daf0d0 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,17 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.8" + +python: + install: + - requirements: requirements.txt + - requirements: docs/requirements.txt + - method: pip + path: . diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..a0833c0 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +sphinx==7.1.2 +sphinx_rtd_theme==2.0.0 +readthedocs-sphinx-search==0.3.2 From 1cb8a1697fecbde10b1c8fa0cbfeff89be2f5816 Mon Sep 17 00:00:00 2001 From: Peter Briggs Date: Fri, 16 Feb 2024 16:12:03 +0000 Subject: [PATCH 3/3] Update documentation configuration file to specify the RTD theme. --- docs/source/conf.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 886a9c8..341eba8 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -26,7 +26,8 @@ # 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.autodoc', +extensions = ['sphinx_rtd_theme', + 'sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx.ext.intersphinx',] @@ -97,7 +98,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +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