From d61ce879ee5f0fbe49b873117bd69009a9bc64ad Mon Sep 17 00:00:00 2001 From: Zach Burnett Date: Tue, 20 Sep 2022 12:53:58 -0400 Subject: [PATCH 1/5] use canonical filename of RTD configuration, enable `nitpicky` mode, and add `fail_on_warning` --- .readthedocs.yml => .readthedocs.yaml | 4 +++- docs/source/conf.py | 3 +++ 2 files changed, 6 insertions(+), 1 deletion(-) rename .readthedocs.yml => .readthedocs.yaml (90%) diff --git a/.readthedocs.yml b/.readthedocs.yaml similarity index 90% rename from .readthedocs.yml rename to .readthedocs.yaml index bb51713..2554633 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yaml @@ -1,4 +1,4 @@ -# .readthedocs.yml +# .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details @@ -7,7 +7,9 @@ version: 2 # Build documentation in the docs/ directory with Sphinx sphinx: + builder: html configuration: docs/source/conf.py + fail_on_warning: true # Build documentation with MkDocs #mkdocs: diff --git a/docs/source/conf.py b/docs/source/conf.py index e36b0b1..c553771 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -208,3 +208,6 @@ # If false, no module index is generated. #latex_use_modindex = True + +# Enable nitpicky mode - which ensures that all references in the docs resolve. +nitpicky = True \ No newline at end of file From ddd532acc8acfcd6af1fccbf8d413114abe5bb2c Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Tue, 12 Mar 2024 12:32:17 -0400 Subject: [PATCH 2/5] update build configuration --- .readthedocs.yaml | 9 ++++++++- docs/rtd_environment.yaml | 9 +++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/rtd_environment.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 2554633..6a8c11c 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -18,9 +18,16 @@ sphinx: # Optionally build your docs in additional formats such as PDF and ePub formats: all +build: + os: ubuntu-22.04 + tools: + python: mambaforge-4.10 + +conda: + environment: docs/rtd_environment.yaml + # Optionally set the version of Python and requirements required to build your docs python: - version: 3.7 install: - method: pip path: . 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 From acfbc78163c13954b97a1e9921262c95796ca9e2 Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Tue, 12 Mar 2024 12:36:38 -0400 Subject: [PATCH 3/5] underline fix --- costools/timefilter.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/costools/timefilter.py b/costools/timefilter.py index 49b7d0b..02aaad1 100755 --- a/costools/timefilter.py +++ b/costools/timefilter.py @@ -224,7 +224,7 @@ def toRect(longitude, latitude): latitude in degrees. Returns - -------- + ------- array_like Unit vector in rectangular coordinates. """ From b7013bca36fdb458b8fb489db15dbe1a9a3495ce Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Tue, 9 Jul 2024 10:18:46 -0400 Subject: [PATCH 4/5] test not failing on warning --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 6a8c11c..c8a0cd8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 sphinx: builder: html configuration: docs/source/conf.py - fail_on_warning: true + fail_on_warning: false # Build documentation with MkDocs #mkdocs: From f6c2c5968f85c7ec0c17fe6a6b1c5717cdcca28e Mon Sep 17 00:00:00 2001 From: zacharyburnett Date: Mon, 2 Feb 2026 13:57:16 -0500 Subject: [PATCH 5/5] use Python 3.13 and remove sphinx from mamba environment --- .readthedocs.yaml | 4 ++-- docs/rtd_environment.yaml | 5 +---- setup.py | 1 + 3 files changed, 4 insertions(+), 6 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c8a0cd8..3daf865 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -19,9 +19,9 @@ sphinx: formats: all build: - os: ubuntu-22.04 + os: ubuntu-24.04 tools: - python: mambaforge-4.10 + python: mambaforge-latest conda: environment: docs/rtd_environment.yaml diff --git a/docs/rtd_environment.yaml b/docs/rtd_environment.yaml index aeebc4d..0bdfcca 100644 --- a/docs/rtd_environment.yaml +++ b/docs/rtd_environment.yaml @@ -1,9 +1,6 @@ -name: rtd311 channels: - conda-forge - - defaults dependencies: - - python=3.11 + - python=3.13 - pip - graphviz - - sphinx_rtd_theme>1.2.0 diff --git a/setup.py b/setup.py index 7db4573..0f06371 100755 --- a/setup.py +++ b/setup.py @@ -19,6 +19,7 @@ 'docs': [ 'sphinx', 'numpydoc', + 'sphinx_rtd_theme>1.2.0', ], 'test': [ 'pytest',