|
| 1 | +# .readthedocs.yml |
| 2 | +# Read the Docs configuration file |
| 3 | +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details |
| 4 | + |
| 5 | +version: 2 |
| 6 | + |
| 7 | +# Build documentation in the docs/ directory with Sphinx |
| 8 | +sphinx: |
| 9 | + configuration: docs/conf.py |
| 10 | + fail_on_warning: true |
| 11 | + |
| 12 | +# Optionally set the version of Python and requirements required to build your docs |
| 13 | +python: |
| 14 | + version: "3.11" |
| 15 | + install: |
| 16 | + - requirements: requirements-docs.txt |
| 17 | + - method: pip |
| 18 | + path: . |
| 19 | + extra_requirements: |
| 20 | + - docs |
| 21 | + |
| 22 | +# Build documentation with MkDocs |
| 23 | +#mkdocs: |
| 24 | +# configuration: mkdocs.yml |
| 25 | + |
| 26 | +# Optionally build your docs in additional formats such as PDF |
| 27 | +formats: ["pdf"] |
| 28 | + |
| 29 | +# Optionally set the version of Python and requirements required to build your docs |
| 30 | +build: |
| 31 | + os: ubuntu-22.04 |
| 32 | + tools: |
| 33 | + python: "3.11" |
| 34 | + |
| 35 | + jobs: |
| 36 | + post_install: |
| 37 | + - python -m pip install --upgrade pip setuptools wheel |
| 38 | + - pip install -r docs/requirements.txt |
| 39 | + |
| 40 | +# Optionally build your docs in additional formats such as PDF |
| 41 | +# formats: |
| 42 | +# - pdf |
| 43 | +# - epub |
| 44 | + |
| 45 | +# Optionally include additional paths needed for your documentation |
| 46 | +# include: |
| 47 | +# - _static |
| 48 | +# - _templates |
| 49 | + |
| 50 | +# Optionally set the default version to "latest" |
| 51 | +# default_version: latest |
| 52 | + |
| 53 | +# Optionally hide the build date to avoid spurious rebuilds |
| 54 | +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html |
| 55 | +# build: |
| 56 | +# os: ubuntu-20.04 |
| 57 | +# tools: |
| 58 | +# python: "3.9" |
| 59 | +# jobs: |
| 60 | +# post_install: |
| 61 | +# - python -m pip install --upgrade pip setuptools wheel |
| 62 | +# - pip install -r docs/requirements.txt |
| 63 | + |
| 64 | +# Optionally set the default version to "latest" |
| 65 | +# default_version: latest |
| 66 | + |
| 67 | +# Optionally hide the build date to avoid spurious rebuilds |
| 68 | +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html |
| 69 | +# build: |
| 70 | +# os: ubuntu-20.04 |
| 71 | +# tools: |
| 72 | +# python: "3.9" |
| 73 | +# jobs: |
| 74 | +# post_install: |
| 75 | +# - python -m pip install --upgrade pip setuptools wheel |
| 76 | +# - pip install -r docs/requirements.txt |
0 commit comments