Skip to content

Commit

Permalink
Add config for automated documentation build
Browse files Browse the repository at this point in the history
  • Loading branch information
cklb committed Oct 9, 2024
1 parent 8b18ed9 commit 20a2766
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 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 OS, Python version and other tools you might need
build:
os: ubuntu-24.04
tools:
python: "3.12"


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


# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub


# 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:
- docs

0 comments on commit 20a2766

Please sign in to comment.