Skip to content

Commit

Permalink
Add yaml for ReadTheDocs build
Browse files Browse the repository at this point in the history
  • Loading branch information
bereba committed Jan 14, 2025
1 parent 4f14fa7 commit 3da09a5
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 @@
# .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 OS, Python version and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.9"
# You can also specify other tool versions:
nodejs: "18"
# rust: "1.64"
# golang: "1.19"
jobs:
post_install:
- npm install -g jsdoc

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

# 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: .
- requirements: docs/requirements.txt

0 comments on commit 3da09a5

Please sign in to comment.