Skip to content

Commit

Permalink
readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
irmen committed Feb 21, 2024
1 parent 5fb0133 commit 4835bf3
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# .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"

# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt

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

# If using Sphinx, optionally build your docs in additional formats such as PDF
formats:
- pdf
- epub
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
sphinx>7.0.0
sphinx_rtd_theme>=1.2
sphinxcontrib-jquery

0 comments on commit 4835bf3

Please sign in to comment.