From 97c003b7420679eaf41a001b88677104919b14d5 Mon Sep 17 00:00:00 2001 From: Manas Rachh Date: Tue, 31 Oct 2023 13:43:39 -0400 Subject: [PATCH 1/4] adding readthedocs yaml --- .readthedocs.yaml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..d69d7c2 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,32 @@ +# .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 OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + # You can also specify other tool versions: + # nodejs: "19" + # rust: "1.64" + # golang: "1.19" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# 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 From 6ea419feb0f7a24cc7dd5f1ebebbac4617a6955c Mon Sep 17 00:00:00 2001 From: Manas Rachh Date: Tue, 31 Oct 2023 13:46:45 -0400 Subject: [PATCH 2/4] updating conf --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index aa90e8e..6f2189e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -83,7 +83,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx_rtd_theme' +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 From af21c7c6a6c43aac40fe71ee74e65cab9f5a18f9 Mon Sep 17 00:00:00 2001 From: Manas Rachh Date: Tue, 31 Oct 2023 13:53:09 -0400 Subject: [PATCH 3/4] trying to address themes issue in read the docs --- .readthedocs.yaml | 6 +++--- docs/conf.py | 2 +- docs/requirements.txt | 1 + 3 files changed, 5 insertions(+), 4 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d69d7c2..974aa27 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -27,6 +27,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: docs/requirements.txt diff --git a/docs/conf.py b/docs/conf.py index 6f2189e..aa90e8e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -83,7 +83,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'sphinx-rtd-theme' +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 diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..483a4e9 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +sphinx_rtd_theme From eb4b8bcf8272cf1068536b50e7c9f62483f4e940 Mon Sep 17 00:00:00 2001 From: Manas Rachh Date: Tue, 31 Oct 2023 13:54:49 -0400 Subject: [PATCH 4/4] trying to fix yaml --- .readthedocs.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 974aa27..8325091 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -27,6 +27,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: +python: + install: - requirements: docs/requirements.txt