Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# and https://docs.readthedocs.com/platform/stable/intro/add-project.html
# on how to add a project to Readthedocs

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-lts-latest
tools:
# DO NOT use mambaforge-*; that is currently sunsetted
python: "miniconda-latest"
jobs:
post_create_environment:
- conda run -n ${CONDA_DEFAULT_ENV} pip install . --no-deps
# example how to tweak pre-commands in RTD's weird conda env
# - conda run -n ${CONDA_DEFAULT_ENV} git clone https://github.com/NCAS-CMS/pyfive.git
# - cd pyfive && conda run -n ${CONDA_DEFAULT_ENV} pip install -e .

# Declare the requirements required to build your docs
conda:
environment:
environment.yml

# Build documentation in the doc directory with Sphinx
sphinx:
configuration: doc/conf.py
fail_on_warning: true

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