search

spacetelescope / stginga

Ginga products specific to STScI data analysis.
https://stginga.readthedocs.io
BSD 3-Clause "New" or "Revised" License
6 stars 10 forks source link

use canonical filename of RTD configuration and enable `nitpicky` mode #226

Closed zacharyburnett closed 2 years ago

zacharyburnett commented 2 years ago

Description

update the name of the ReadTheDocs configuration file to .readthedocs.yaml and enable nitpicky mode to validate intra-doc links

pllim commented 2 years ago

Please also fix the 3 warnings. Thanks!

zacharyburnett commented 2 years ago

for reference, warnings are https://readthedocs.org/projects/stginga/builds/18123433/:

/home/docs/checkouts/readthedocs.org/user_builds/stginga/envs/226/lib/python3.9/site-packages/stginga/utils.py:docstring of stginga.utils.scale_image:16: WARNING: py:func reference target not found: scipy.ndimage.interpolation.zoom
/home/docs/checkouts/readthedocs.org/user_builds/stginga/envs/226/lib/python3.9/site-packages/stginga/utils.py:docstring of stginga.utils.scale_image_with_dq:16: WARNING: py:func reference target not found: scipy.ndimage.interpolation.zoom
/home/docs/checkouts/readthedocs.org/user_builds/stginga/envs/226/lib/python3.9/site-packages/stginga/utils.py:docstring of stginga.utils.scale_wcs:21: WARNING: py:func reference target not found: scipy.ndimage.interpolation.zoom