Merge pull request #170 from zacharyburnett/rtd_update

use canonical filename of RTD configuration and enable `nitpicky` mode
spacetelescope · Sep 20, 2022 · 2b17c59 · 2b17c59
2 parents ebf50ec + 218e2be
commit 2b17c59
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 1 deletion.
diff --git a/.github/labeler.yml b/.github/labeler.yml
@@ -1,6 +1,6 @@
 docs:
   - .github/**/*.md
-  - .readthedocs.yml
+  - .readthedocs.yaml
   - doc/**/*
   - '*.md'
   - any: ['*.rst', '!CHANGES.rst']

diff --git a/.readthedocs.yml → .readthedocs.yaml b/.readthedocs.yml → .readthedocs.yaml
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -213,3 +213,6 @@
 linkcheck_ignore = ['https://hsthelp.stsci.edu', 'https://acszeropoints.stsci.edu']
 linkcheck_timeout = 180
 linkcheck_anchors = False
+
+# Enable nitpicky mode - which ensures that all references in the docs resolve.
+nitpicky = False