Skip to content

Commit

Permalink
Merge pull request #167 from SWIFTSIM/JBorrow-patch-2
Browse files Browse the repository at this point in the history
Create .readthedocs.yaml
  • Loading branch information
JBorrow authored Sep 7, 2023
2 parents 16fb45f + 6820bf4 commit 0106dcb
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# 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"
jobs:
post_create_environment:
- python3 -m pip install swiftsimio
- python3 -m pip install -r optional_requirements.txt

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/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:
- requirements: docs/requirements.txt

0 comments on commit 0106dcb

Please sign in to comment.