Skip to content

Commit

Permalink
Add .readthedocs.yaml file to configure ReadTheDocs builds (#117)
Browse files Browse the repository at this point in the history
.readthedocs.yaml
- Added this configuration file following the recommendations in
  readthedocs/readthedocs.org #10290.  This is the recommended way
  to point to your requirements.txt and conf.py, as well as to
  specify versions for python and related tools.

Signed-off-by: Bob Yantosca <[email protected]>
  • Loading branch information
yantosca authored May 16, 2023
1 parent 3adbe30 commit 8a5fd04
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
#
# NOTE: This is now needed in order to prevent builds from failing due
# to Python package issues at the ReadTheDocs site. For more info, see:
# https://github.com/readthedocs/readthedocs.org/issues/10290
# -- Bob Yantosca (10 May 2023)

# Required
version: 2

## Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.7"
nodejs: "14"
rust: "1.55"
golang: "1.17"

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

# If using Sphinx, optionally build your docs in additional formats such as PDF
formats: all

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

0 comments on commit 8a5fd04

Please sign in to comment.