From c2f7f0072b08702422e028ef67cee5911834bcda Mon Sep 17 00:00:00 2001 From: Mark Dickinson Date: Wed, 30 Jun 2021 18:20:10 +0100 Subject: [PATCH 1/4] Add minimal config file for Read the Docs --- .readthedocs.yaml | 9 +++++++++ docs/requirements.txt | 2 ++ 2 files changed, 11 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 000000000..c2a3f3d17 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,9 @@ +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +python: + version: 3.7 + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..2cda158fb --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +Sphinx>=2.1.0 +enthought-sphinx-theme From 4664ec00ff0cf01acfb27f50445a3dd757aac14a Mon Sep 17 00:00:00 2001 From: Mark Dickinson Date: Wed, 30 Jun 2021 18:33:16 +0100 Subject: [PATCH 2/4] Add instructions to install package; remove docs/requirements.txt --- .readthedocs.yaml | 4 +++- docs/requirements.txt | 2 -- 2 files changed, 3 insertions(+), 3 deletions(-) delete mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c2a3f3d17..ba512c16c 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,4 +6,6 @@ version: 2 python: version: 3.7 install: - - requirements: docs/requirements.txt + - method: pip + path: . + extra_requirements: docs diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 2cda158fb..000000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -Sphinx>=2.1.0 -enthought-sphinx-theme From 37020f30a0dfa2a5ea9a2b40302658021f2d4ab3 Mon Sep 17 00:00:00 2001 From: Mark Dickinson Date: Wed, 30 Jun 2021 18:35:31 +0100 Subject: [PATCH 3/4] Fix syntax for extra_requirements --- .readthedocs.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index ba512c16c..f3202bf46 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,4 +8,5 @@ python: install: - method: pip path: . - extra_requirements: docs + extra_requirements: + - docs From 78c370208e800467ccabb5e9282c2517a205c748 Mon Sep 17 00:00:00 2001 From: Mark Dickinson Date: Wed, 30 Jun 2021 18:40:02 +0100 Subject: [PATCH 4/4] Use Python 3.8 rather than 3.7 --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f3202bf46..963f56f26 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -4,7 +4,7 @@ version: 2 python: - version: 3.7 + version: 3.8 install: - method: pip path: .