workload-automation/.readthedocs.yml

# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
  builder: html
  configuration: doc/source/conf.py

# Build the docs in additional formats such as PDF and ePub
formats: all

# Set the version of Python and requirements required to build your docs
python:
   version: 3.8
   install:
      - method: setuptools
        path: .
      - requirements: doc/requirements.txt
readthedocs: Add ReadtheDocs configuration Provide configuration file for building the documentation. We need to specify to use python3 explicitly. 2019-08-28 11:44:00 +01:00			`# .readthedocs.yml`
			`# Read the Docs configuration file`
			`# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details`

			`# Required`
			`version: 2`

			`# Build documentation in the docs/ directory with Sphinx`
			`sphinx:`
			`builder: html`
			`configuration: doc/source/conf.py`

			`# Build the docs in additional formats such as PDF and ePub`
			`formats: all`

			`# Set the version of Python and requirements required to build your docs`
			`python:`
docs/.readthedocs: Bump the python version Bump the python version used to build the documentation to prevent installation errors in the build environment. 2022-08-18 16:55:28 +01:00			`version: 3.8`
readthedocs: Add ReadtheDocs configuration Provide configuration file for building the documentation. We need to specify to use python3 explicitly. 2019-08-28 11:44:00 +01:00			`install:`
			`- method: setuptools`
			`path: .`
docs: Update readthedocs package versions The latest sphinx and docutils versions currently used on readthedocs are no longer compatible. Explicitly list the package versions that should be used when building the documentation. 2021-10-28 10:48:19 +01:00			`- requirements: doc/requirements.txt`