From 27fabbf31f4b440f6c16f8a65582a5d0c5946bc8 Mon Sep 17 00:00:00 2001 From: Sean Fraser Date: Sun, 28 Apr 2024 22:32:44 -0400 Subject: [PATCH] fix RTD doc generation --- .readthedocs.yaml | 22 ++++++++++++++++++++++ docs/requirements.txt | 1 + docs/source/conf.py | 4 +++- 3 files changed, 26 insertions(+), 1 deletion(-) 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..35f3e91 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..1cbde8e --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +sphinx_rtd_theme==1.3.0 diff --git a/docs/source/conf.py b/docs/source/conf.py index ed5d4ec..96fb518 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -29,7 +29,9 @@ # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = [ + 'sphinx_rtd_theme', +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']