From e8454e104be4aeb5dcd61efcb943aa677a918fd4 Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Mon, 8 Jan 2024 14:51:51 -0500 Subject: [PATCH 1/2] rename to canonical filename --- .readthedocs.yml => .readthedocs.yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .readthedocs.yml => .readthedocs.yaml (100%) diff --git a/.readthedocs.yml b/.readthedocs.yaml similarity index 100% rename from .readthedocs.yml rename to .readthedocs.yaml From 6777ab692d911c2ae6d944e4a89c5c7c39006266 Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Mon, 8 Jan 2024 14:53:34 -0500 Subject: [PATCH 2/2] fix readthedocs config --- .readthedocs.yaml | 20 ++++++++++++++------ docs/rtd_environment.yaml | 9 +++++++++ 2 files changed, 23 insertions(+), 6 deletions(-) create mode 100644 docs/rtd_environment.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c72bd78..fcb98ac 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -2,20 +2,28 @@ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details version: 2 +# Build documentation in the docs/ directory with Sphinx sphinx: builder: html configuration: docs/conf.py fail_on_warning: true -# Set the version of Python and requirements required to build your docs +# Optionally build your docs in additional formats such as PDF and ePub +formats: + - htmlzip + - pdf + +build: + os: ubuntu-22.04 + tools: + python: mambaforge-4.10 + +conda: + environment: docs/rtd_environment.yaml + python: - version: 3.8 - system_packages: true install: - method: pip path: . extra_requirements: - docs - -# Don't build any extra formats -formats: [] diff --git a/docs/rtd_environment.yaml b/docs/rtd_environment.yaml new file mode 100644 index 0000000..aeebc4d --- /dev/null +++ b/docs/rtd_environment.yaml @@ -0,0 +1,9 @@ +name: rtd311 +channels: + - conda-forge + - defaults +dependencies: + - python=3.11 + - pip + - graphviz + - sphinx_rtd_theme>1.2.0