Skip to content

Commit

Permalink
chore: add readthedocs config
Browse files Browse the repository at this point in the history
  • Loading branch information
overcat committed Jan 2, 2024
1 parent c66d910 commit e513d27
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# .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.12"

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

# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
install:
- method: pip
path: .
- requirements: docs/requirements.txt

# Build PDF & ePub
formats:
- epub
- pdf

0 comments on commit e513d27

Please sign in to comment.