Arthur She | e61625a | 2024-01-06 20:46:36 -0800 | [diff] [blame] | 1 | # .readthedocs.yaml |
| 2 | # Read the Docs configuration file |
| 3 | # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details |
Arthur She | 293df66 | 2024-01-06 20:41:15 -0800 | [diff] [blame] | 4 | |
Arthur She | e61625a | 2024-01-06 20:46:36 -0800 | [diff] [blame] | 5 | # Required |
Arthur She | 293df66 | 2024-01-06 20:41:15 -0800 | [diff] [blame] | 6 | version: 2 |
| 7 | |
Arthur She | e61625a | 2024-01-06 20:46:36 -0800 | [diff] [blame] | 8 | # Set the OS, Python version and other tools you might need |
Arthur She | 293df66 | 2024-01-06 20:41:15 -0800 | [diff] [blame] | 9 | build: |
Arthur She | e61625a | 2024-01-06 20:46:36 -0800 | [diff] [blame] | 10 | os: ubuntu-22.04 |
Arthur She | 293df66 | 2024-01-06 20:41:15 -0800 | [diff] [blame] | 11 | tools: |
Arthur She | e61625a | 2024-01-06 20:46:36 -0800 | [diff] [blame] | 12 | python: "3.12" |
| 13 | # You can also specify other tool versions: |
| 14 | # nodejs: "19" |
| 15 | # rust: "1.64" |
| 16 | # golang: "1.19" |
Arthur She | 805c512 | 2024-01-06 20:55:19 -0800 | [diff] [blame] | 17 | # apt_packages: |
| 18 | # - |
| 19 | jobs: |
| 20 | post_create_environment: |
| 21 | - pip install sphinx_rtd_theme |
Arthur She | 293df66 | 2024-01-06 20:41:15 -0800 | [diff] [blame] | 22 | |
Arthur She | e61625a | 2024-01-06 20:46:36 -0800 | [diff] [blame] | 23 | # Build documentation in the "docs/" directory with Sphinx |
Arthur She | 293df66 | 2024-01-06 20:41:15 -0800 | [diff] [blame] | 24 | sphinx: |
| 25 | configuration: docs/conf.py |
| 26 | |
Arthur She | e61625a | 2024-01-06 20:46:36 -0800 | [diff] [blame] | 27 | # Optionally build your docs in additional formats such as PDF and ePub |
| 28 | # formats: |
| 29 | # - pdf |
| 30 | # - epub |
Arthur She | 293df66 | 2024-01-06 20:41:15 -0800 | [diff] [blame] | 31 | |
Arthur She | e61625a | 2024-01-06 20:46:36 -0800 | [diff] [blame] | 32 | # Optional but recommended, declare the Python requirements required |
| 33 | # to build your documentation |
| 34 | # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html |
| 35 | # python: |
| 36 | # install: |
| 37 | # - requirements: docs/requirements.txt |