From 1672979dc639fa4f52b97de5b1bb55f94ae14811 Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Wed, 11 Feb 2026 11:06:28 -0500 Subject: [PATCH] add default ReadTheDocs configuration with `graphviz` installed --- .readthedocs.yaml | 14 ++++++++--- docs/rtd_environment.yaml | 8 ------ .../.readthedocs.yaml | 25 +++++++++++++++++++ 3 files changed, 35 insertions(+), 12 deletions(-) delete mode 100644 docs/rtd_environment.yaml create mode 100644 {{ cookiecutter.package_name }}/.readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b679dad..bd4d0af 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,12 +1,18 @@ +# yaml-language-server: $schema=https://raw.githubusercontent.com/readthedocs/readthedocs.org/refs/heads/main/readthedocs/rtd_tests/fixtures/spec/v2/schema.json +# https://docs.readthedocs.io/en/stable/config-file/v2.html + version: 2 build: os: ubuntu-lts-latest tools: - python: mambaforge-latest - -conda: - environment: docs/rtd_environment.yaml + python: latest + apt_packages: + - graphviz sphinx: + builder: html configuration: docs/conf.py + fail_on_warning: true + +formats: [] diff --git a/docs/rtd_environment.yaml b/docs/rtd_environment.yaml deleted file mode 100644 index f0fee16..0000000 --- a/docs/rtd_environment.yaml +++ /dev/null @@ -1,8 +0,0 @@ -name: rtd311 -channels: - - conda-forge - - defaults -dependencies: - - python=3.11 - - pip - - graphviz diff --git a/{{ cookiecutter.package_name }}/.readthedocs.yaml b/{{ cookiecutter.package_name }}/.readthedocs.yaml new file mode 100644 index 0000000..d9f41d2 --- /dev/null +++ b/{{ cookiecutter.package_name }}/.readthedocs.yaml @@ -0,0 +1,25 @@ +# yaml-language-server: $schema=https://raw.githubusercontent.com/readthedocs/readthedocs.org/refs/heads/main/readthedocs/rtd_tests/fixtures/spec/v2/schema.json +# https://docs.readthedocs.io/en/stable/config-file/v2.html + +version: 2 + +build: + os: ubuntu-lts-latest + tools: + python: latest + apt_packages: + - graphviz + +python: + install: + - method: pip + path: . + extra_requirements: + - docs + +sphinx: + builder: html + configuration: docs/conf.py + fail_on_warning: true + +formats: []