diff --git a/readthedocs.yml b/readthedocs.yml index fb2d1374bb..0d2c5c6b7b 100644 --- a/readthedocs.yml +++ b/readthedocs.yml @@ -1,7 +1,41 @@ +# .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.9" + +# Build documentation in the docs/ directory with Sphinx +sphinx: + configuration: docs/sphinx/source/conf.py + +# If using Sphinx, optionally build your docs in additional formats such as PDF +# formats: +# - pdf + +# Optionally declare the Python requirements required to build your docs python: - version: 3 - # only use the packages specified in setup.py - use_system_site_packages: false - pip_install: true + install: + # - requirements: docs/requirements.txt + - method: pip + path: . extra_requirements: - - doc \ No newline at end of file + - docs + + # python.version deprecated in v2 replaced by build.tools.python + # version: 3 + + # setup_py_install replaced by python.install in v2 + # only use the packages specified in setup.py + + # renamed to python.system_packages in v2 + # use_system_site_packages: false + + # replaced by python.install in v2 + # pip_install: true