From 4a2b51f2b83e7d6535336ccb76cb0ef2ebf7b77f Mon Sep 17 00:00:00 2001 From: "pedro.minatel" Date: Mon, 26 Jun 2023 11:51:40 +0100 Subject: [PATCH 1/2] Added the ReadTheDocs configuration file --- .github/workflows/docs.yml | 4 ++-- .readthedocs.yml | 22 ++++++++++++++++++++++ 2 files changed, 24 insertions(+), 2 deletions(-) create mode 100644 .readthedocs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 3c76df5f741..f01fb76ee84 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -17,7 +17,7 @@ jobs: build-docs: name: Build ReadTheDocs - runs-on: ubuntu-latest + runs-on: ubuntu-22.04 defaults: run: shell: bash @@ -27,7 +27,7 @@ jobs: submodules: true - uses: actions/setup-python@v4 with: - python-version: '3.x' + python-version: '3.10' - name: Build run: | sudo apt update diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000000..fb24fa160d8 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,22 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.10" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/conf.py + +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: docs/requirements.txt \ No newline at end of file From 2ae11552e4e6d7a2d08655d2fe72ba7a9fc9aa71 Mon Sep 17 00:00:00 2001 From: "pedro.minatel" Date: Mon, 26 Jun 2023 11:55:08 +0100 Subject: [PATCH 2/2] File renamed to YAML --- .readthedocs.yaml | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000000..259c19f98fd --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,20 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.10" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +python: + install: + - requirements: docs/requirements.txt