Skip to content

Commit

Permalink
docs: Add a v2 .readthedocs.yaml config file
Browse files Browse the repository at this point in the history
Read the Docs will start requiring a .readthedocs.yaml configuration
file for all projects in order to build documentation successfully.

For more information, read the blog post available at:

https://blog.readthedocs.com/migrate-configuration-v2/
  • Loading branch information
scorphus committed Jul 23, 2023
1 parent 3e35fc0 commit 7763d83
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .readthedocs.yaml
@@ -0,0 +1,26 @@
# .readthedocs.yaml
# Read the Docs configuration file
# 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
build:
os: ubuntu-22.04
tools:
python: "3.11"

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

# Build docs in PDF and ePub formats
formats:
- pdf
- epub

# Specify Python requirements
python:
install:
- requirements: docs/requirements.txt

0 comments on commit 7763d83

Please sign in to comment.