Connect with Read the DocsΒΆ

Only one step is necessary to upload the documentation to Read the Docs, that is create a .readthedocs.yml in the root of the project with the following content:

[ ]:
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
sphinx:
  configuration: docs/source/conf.py

# Build documentation with MkDocs
#mkdocs:
#  configuration: mkdocs.yml

# Optionally set the version of Python and requirements required to build your docs
python:
  install:
    - requirements: docs/requirements


# Set the version of Python and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.11"

formats:
  - epub
  - pdf

Special attention to the Default branch definition:

Read the Docs