Skip to content
This repository was archived by the owner on Aug 28, 2024. It is now read-only.

Commit

Permalink
Added the .readthedocs.yaml file
Browse files Browse the repository at this point in the history
  • Loading branch information
daminton committed Dec 19, 2023
1 parent 2118bbe commit dbfafcd
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
30 changes: 30 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation with Sphinx
sphinx:
configuration: docs/conf.py
fail_on_warning: false # Optional: Set to true if you want the build to fail on warnings.

# Optionally set the OS, Python version and other tools
build:
os: ubuntu-22.04
tools:
python: "3.11"

# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
# - epub

python:
install:
- requirements: docs/requirements.txt
- method: pip
path: .
extra_requirements:
- docs
3 changes: 2 additions & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ sphinxext-rediraffe
sphinxext-opengraph
sphinx-fortran
nbsphinx
ipython
ipython
swiftest

0 comments on commit dbfafcd

Please sign in to comment.