Skip to content

Commit

Permalink
Add .readthedocs.yaml file
Browse files Browse the repository at this point in the history
  • Loading branch information
wlorenzetti committed Jan 16, 2024
1 parent 6bdbb19 commit 4944700
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# 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-22.04
tools:
python: "3.10"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"


# Build documentation in the "docs/" directory with Sphinx

sphinx:
configuration: conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# 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:
- requirements: requirements.txt

0 comments on commit 4944700

Please sign in to comment.