From cf5c37c8e6be6345306559f603ad2d46f822a3b8 Mon Sep 17 00:00:00 2001 From: Daan Koning Date: Sat, 13 Jan 2024 13:39:54 +0100 Subject: [PATCH 1/3] Create .readthedocs.yaml --- .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..dd2aa46 --- /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/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 6e0439c28d628e8c73f534d1bba6960baf78c4a8 Mon Sep 17 00:00:00 2001 From: Daan Koning Date: Sat, 13 Jan 2024 13:49:21 +0100 Subject: [PATCH 2/3] Fix rtd build --- .readthedocs.yaml | 6 +++--- docs/requirements.txt | 2 ++ requirements.txt | 2 -- 3 files changed, 5 insertions(+), 5 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.readthedocs.yaml b/.readthedocs.yaml index dd2aa46..bff923c 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -30,6 +30,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/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..d8166e2 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +sphinx-rtd-theme +myst_parser \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index d8166e2..e69de29 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +0,0 @@ -sphinx-rtd-theme -myst_parser \ No newline at end of file From ff46fde7567f1b9770e33c6cc9500d36704996df Mon Sep 17 00:00:00 2001 From: Daan Koning Date: Sat, 13 Jan 2024 13:51:56 +0100 Subject: [PATCH 3/3] Remove obsolete workflow --- .github/workflows/docs.yml | 25 ------------------------- 1 file changed, 25 deletions(-) delete mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml deleted file mode 100644 index 701e360..0000000 --- a/.github/workflows/docs.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: "Test documentation functionality" -on: [push, pull_request] - -jobs: - test-documentation: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@v3 - - - name: Set up Python 3.10 - uses: actions/setup-python@v4 - with: - python-version: "3.10" - - - name: Install dependencies - run: | - python -m pip install --upgrade pip - python -m pip install -r requirements.txt - - - name: Verify documentation - run: | - sphinx-apidoc -o docs src/ - cd docs - make html \ No newline at end of file