|
1 | 1 | # .readthedocs.yml |
2 | | -# Read the Docs configuration file |
3 | | -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details |
4 | | - |
| 2 | +# Minimal Read the Docs configuration |
5 | 3 | version: 2 |
6 | 4 |
|
7 | | -# Build documentation in the docs/ directory with Sphinx |
| 5 | +# Build documentation with Sphinx |
8 | 6 | sphinx: |
9 | 7 | configuration: docs/conf.py |
10 | | - fail_on_warning: true |
| 8 | + fail_on_warning: false |
11 | 9 |
|
12 | | -# Optionally set the version of Python and requirements required to build your docs |
| 10 | +# Python configuration |
13 | 11 | python: |
14 | 12 | version: "3.11" |
15 | 13 | install: |
16 | | - - requirements: requirements-docs.txt |
17 | 14 | - method: pip |
18 | 15 | 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"] |
| 16 | + extra_requirements: ["docs"] |
| 17 | + - requirements: requirements-docs.txt |
28 | 18 |
|
29 | | -# Optionally set the version of Python and requirements required to build your docs |
| 19 | +# Build configuration |
30 | 20 | build: |
31 | 21 | os: ubuntu-22.04 |
32 | 22 | tools: |
33 | 23 | python: "3.11" |
34 | 24 |
|
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 |
| 25 | +# Optional: Uncomment to build PDF as well |
| 26 | +# formats: [pdf] |
0 commit comments