Skip to content

Commit

Permalink
update read the docs config
Browse files Browse the repository at this point in the history
  • Loading branch information
Chrismarsh committed Jan 16, 2024
1 parent 027b529 commit 6ade925
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.12"

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

# Optionally build your docs in additional formats such as PDF
formats:
- htmlzip

# Optionally set the version of Python and requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
breathe<4.13.0
exhale
sphinx_rtd_theme

0 comments on commit 6ade925

Please sign in to comment.