Skip to content

Commit

Permalink
Add .readthedocs.yaml to specify legacy RTD build container
Browse files Browse the repository at this point in the history
.readthedocs.yaml
- Now use one of the legacy build containers to avoid issues
  with RTD builds.

Signed-off-by: Bob Yantosca <yantosca@seas.harvard.edu>
  • Loading branch information
yantosca committed May 11, 2023
1 parent 30dfc6d commit a8562a2
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# .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"
# # You can also specify other tool versions:
# #nodejs: "19"
# #rust: "1.64"
# #golang: "1.19"


# Use the legacy image to avoid issues with older python packages
# -- Bob Yantosca (11 May 2023)
# Set the version of Python and other tools you might need
build:
image: latest
apt_packages:
- libclang
- cmake
python:
version: "3.7"

# 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:
# - pdf

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

0 comments on commit a8562a2

Please sign in to comment.