Skip to content

Commit

Permalink
docs: give 0.7.x series readthedocs config
Browse files Browse the repository at this point in the history
  • Loading branch information
lgray authored Nov 21, 2024
1 parent b3dbff3 commit c2738e6
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit c2738e6

Please sign in to comment.