From 4d5334329ba6f2e2fd5730a9934c79b69bcff2b1 Mon Sep 17 00:00:00 2001 From: Valeriu Predoi Date: Wed, 19 Nov 2025 15:40:03 +0000 Subject: [PATCH 1/2] add RTD config yaml file --- .readthedocs.yaml | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..4e4a19c --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,33 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# 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 From dec4911b79ed542dbef43a70a8f44a628d9c2136 Mon Sep 17 00:00:00 2001 From: Valeriu Predoi Date: Wed, 19 Nov 2025 15:43:02 +0000 Subject: [PATCH 2/2] add docs line in comment --- .readthedocs.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 4e4a19c..579f246 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,6 +1,8 @@ # .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