From 740c3327db2ebdd759b318a32b092375ef8af10c Mon Sep 17 00:00:00 2001 From: Nitin Madnani Date: Wed, 3 Jan 2024 16:49:54 -0500 Subject: [PATCH 1/4] Add readthedocs yaml configuration file. --- .readthedocs.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..9d9fd80 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,18 @@ +# .readthedocs.yml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: doc/conf.py + +# Optionally build your docs in additional formats such as PDF and ePub +formats: all + +build: + os: "ubuntu-22.04" + tools: + python: "3.11" From f16fc9fe9ddd0d4241e83594e69a324ccb227c15 Mon Sep 17 00:00:00 2001 From: Nitin Madnani Date: Wed, 3 Jan 2024 16:50:35 -0500 Subject: [PATCH 2/4] Fix `doc/conf.py`. Use latest intersphinx mapping format. --- doc/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 2e02e3f..fe8eec3 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -218,6 +218,6 @@ # Example configuration for intersphinx: refer to the Python standard library. intersphinx_mapping = { - "https://docs.python.org/": None, - "https://numpy.org/doc/stable/": None, + "python": ("https://docs.python.org/3", None), + "numpy": ("https://numpy.org/doc/stable/", None), } From 604be57ed6bb1581b6743e8809dae46917300aa2 Mon Sep 17 00:00:00 2001 From: Nitin Madnani Date: Wed, 3 Jan 2024 16:53:16 -0500 Subject: [PATCH 3/4] Add `doc/requirements.txt`. --- doc/requirements.txt | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 doc/requirements.txt diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..2cf6891 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,6 @@ +numpy +pandas +scikit-learn +scipy +sphinx +sphinx_rtd_theme From ff2ef227d425b3cc697f9b0b993ee7ecd5377df9 Mon Sep 17 00:00:00 2001 From: Nitin Madnani Date: Wed, 3 Jan 2024 16:54:44 -0500 Subject: [PATCH 4/4] Update readthedocs config to use requirements. --- .readthedocs.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.readthedocs.yml b/.readthedocs.yml index 9d9fd80..2bfc8ac 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -12,6 +12,11 @@ sphinx: # Optionally build your docs in additional formats such as PDF and ePub formats: all +# Optionally set the version of Python and requirements required to build your docs +python: + install: + - requirements: doc/requirements.txt + build: os: "ubuntu-22.04" tools: