Skip to content

Commit

Permalink
Updated ReadTheDocs config file
Browse files Browse the repository at this point in the history
  • Loading branch information
ojustino committed Nov 20, 2023
1 parent e304ef5 commit 98f97d8
Showing 1 changed file with 23 additions and 16 deletions.
39 changes: 23 additions & 16 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,26 +1,33 @@
# .readthedocs.yaml
# Read the Docs configuration file
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Build documentation in the docs/ directory with Sphinx
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04 # (now required to build RTD)
tools:
python: "3.12"
# You can also specify other tool versions:
# nodejs: "20"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
configuration: docs/conf.py
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true

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

conda:
environment: environment.yml

build:
image: testing

# Optionally set the version of Python and requirements required to build your docs
#python:
# version: 3.9
# 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
# - requirements: docs/requirements.txt

0 comments on commit 98f97d8

Please sign in to comment.