diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..eba1a0ef1 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,42 @@ +# .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 OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.11" + apt_packages: + - graphviz + jobs: + post_checkout: + - 'sed s/docs\\\/source\\\/// -i.bak README.rst' + - diff README.rst.bak README.rst || true + post_install: + - python -m pip install '.[dev]' rucio-clients + pre_build: + - cd docs && sphinx-autogen source/reference.rst -t source/_templates -o source/modules && cd ../ + # You can also specify other tool versions: + # nodejs: "19" + # rust: "1.64" + # golang: "1.19" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/source/conf.py + +# 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