Add .readthedocs.yaml configuration file (#8352)

* Added the ReadTheDocs configuration file

* File renamed to YAML
This commit is contained in:
Pedro Minatel 2023-07-17 11:57:25 +01:00 committed by GitHub
parent 7a3768460b
commit fb2aa59145
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 44 additions and 2 deletions

View file

@ -17,7 +17,7 @@ jobs:
build-docs: build-docs:
name: Build ReadTheDocs name: Build ReadTheDocs
runs-on: ubuntu-latest runs-on: ubuntu-22.04
defaults: defaults:
run: run:
shell: bash shell: bash
@ -27,7 +27,7 @@ jobs:
submodules: true submodules: true
- uses: actions/setup-python@v4 - uses: actions/setup-python@v4
with: with:
python-version: '3.x' python-version: '3.10'
- name: Build - name: Build
run: | run: |
sudo apt update sudo apt update

20
.readthedocs.yaml Normal file
View file

@ -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

22
.readthedocs.yml Normal file
View file

@ -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