From f93ca726ed72bb974b329f960f83eff8e9b9f165 Mon Sep 17 00:00:00 2001 From: Brian Gerwe Date: Wed, 7 Aug 2024 12:54:08 -0700 Subject: [PATCH 1/4] add readthedocs template --- .readthedocs.yaml | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..6dffd85 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,35 @@ +# Read the Docs configuration file for Sphinx projects +# 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: "20" + # rust: "1.70" + # golang: "1.20" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/source/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true + +# 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 \ No newline at end of file From f78493d478bd60ce2729872962c60b05911c2468 Mon Sep 17 00:00:00 2001 From: Brian Gerwe Date: Wed, 7 Aug 2024 13:21:58 -0700 Subject: [PATCH 2/4] add packaged requirements to docs building config --- .readthedocs.yaml | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 6dffd85..1221ee2 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,6 +13,13 @@ build: # nodejs: "20" # rust: "1.70" # golang: "1.20" + +# 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: requirements.txt # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -26,10 +33,3 @@ sphinx: # 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 \ No newline at end of file From 13badf42e5735fb03937e9724d28be5646c95a1b Mon Sep 17 00:00:00 2001 From: Brian Gerwe Date: Wed, 7 Aug 2024 13:27:26 -0700 Subject: [PATCH 3/4] update intersphinx_mapping --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index e11d6bf..d92f0f5 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -193,7 +193,7 @@ # -- Options for intersphinx extension --------------------------------------- # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +intersphinx_mapping = {'python': ('https://docs.python.org/', None)} # -- Options for todo extension ---------------------------------------------- From f438def51e88fc31b948af84ecde4d60920f8442 Mon Sep 17 00:00:00 2001 From: Brian Gerwe Date: Wed, 7 Aug 2024 13:32:02 -0700 Subject: [PATCH 4/4] split documentation requirements into separate file and update doc building config --- .readthedocs.yaml | 2 +- docs/requirements.txt | 3 +++ requirements.txt | 2 -- 3 files changed, 4 insertions(+), 3 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1221ee2..653b387 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -19,7 +19,7 @@ build: # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - - requirements: requirements.txt + - requirements: docs/requirements.txt # Build documentation in the "docs/" directory with Sphinx sphinx: diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..080c520 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +numpydoc +nbsphinx +sphinx-rtd-theme diff --git a/requirements.txt b/requirements.txt index 7abe3df..ea8a8d3 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,8 +2,6 @@ altair>=3.0 coveralls==3.2.0 matplotlib>=3.5 numpy>=1.14 -numpydoc -nbsphinx pytest>=4.6 pytest-cov scipy>=1.0