diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 0ad7e1d48..23b8ea029 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,39 +1,29 @@ -# .readthedocs.yaml -# Read the Docs configuration file +# Read the Docs configuration file for Sphinx projects # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required version: 2 -# Set the version of Python and other tools you might need +# Set the OS, Python version and other tools you might need build: os: ubuntu-22.04 tools: python: "3.10" - # You can also specify other tool versions: - # nodejs: "19" - # rust: "1.64" - # golang: "1.19" jobs: pre_build: # Generate the Sphinx configuration for this Jupyter Book so it builds. - "pip install jupyter-book" - "jupyter-book config sphinx docs/" -# Build documentation in the docs/ directory with Sphinx +# Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/conf.py fail_on_warning: false -# If using Sphinx, optionally build your docs in additional formats such as PDF -# formats: -# - pdf - -# Optionally declare the Python requirements required to build your docs +# 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: - method: pip path: . - # extra_requirements: - # - jupyter-book - # - sphinx