From 43d4e6ea79a1b838577e178a0c3e940015319e8a Mon Sep 17 00:00:00 2001 From: James Trayford Date: Tue, 28 Nov 2023 15:42:29 +0000 Subject: [PATCH 1/3] add a rtd config --- .readthedocs.yml | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 .readthedocs.yml diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 0000000..6d943a4 --- /dev/null +++ b/.readthedocs.yml @@ -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.9" + # 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/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 From b57ba56b706e2bb7a18ca08834c4ab87470d7e59 Mon Sep 17 00:00:00 2001 From: James Trayford Date: Tue, 28 Nov 2023 16:51:49 +0000 Subject: [PATCH 2/3] update --- .readthedocs.yml | 10 +++++----- docs/requirements.txt | 1 + 2 files changed, 6 insertions(+), 5 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml index 6d943a4..79684e6 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -23,13 +23,13 @@ sphinx: # fail_on_warning: true # Optionally build your docs in additional formats such as PDF and ePub -# formats: -# - pdf +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 +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..4d90b77 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +strauss @ git+https://github.com/james-trayford/strauss.git@update_docs From a1204912110c2377fc1bbadbc7ee32b8935975f1 Mon Sep 17 00:00:00 2001 From: James Trayford Date: Tue, 28 Nov 2023 17:15:51 +0000 Subject: [PATCH 3/3] update config --- docs/conf.py | 2 +- docs/requirements.txt | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 4969eb1..0b88976 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,7 +18,7 @@ # -- Project information ----------------------------------------------------- project = 'STRAUSS' -copyright = '2021, Dr. James Trayford' +copyright = '2023, Dr. James Trayford' author = 'Dr. James Trayford' # The full version, including alpha/beta/rc tags diff --git a/docs/requirements.txt b/docs/requirements.txt index 4d90b77..a4802d9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1 +1 @@ -strauss @ git+https://github.com/james-trayford/strauss.git@update_docs +strauss @ git+https://github.com/james-trayford/strauss.git