Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

use canonical filename of RTD configuration and enable nitpicky #149

Merged
merged 5 commits into from
May 28, 2024
Merged

use canonical filename of RTD configuration and enable nitpicky #149

merged 5 commits into from
May 28, 2024

Conversation

zacharyburnett
Copy link
Collaborator

Description

change .readthedocs.yml -> .readthedocs.yaml and also enable nitpicky to validate links

@zacharyburnett zacharyburnett self-assigned this Sep 20, 2022
@pllim
Copy link
Contributor

pllim commented Sep 20, 2022

Please fix the warnings too. Thanks!

@pllim
Copy link
Contributor

pllim commented Sep 20, 2022

This is very old code. Be careful not to go too deep in the rabbit hole.

@zacharyburnett
Copy link
Collaborator Author

This is very old code. Be careful not to go too deep in the rabbit hole.

Good point, I will call it here then.

pllim
pllim reviewed Sep 20, 2022
View reviewed changes
doc/source/conf.py Outdated
Comment on lines 215 to 216
('py:class', 'astropy.io.fits.hdu.image.PrimaryHDU'),
('py:class', 'astropy.io.fits.hdu.image.ImageHDU'),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of ignoring, use the proper API ref for astropy.io.fits objects.

https://docs.astropy.org/en/stable/io/fits/api/images.html#astropy.io.fits.ImageHDU

https://docs.astropy.org/en/stable/io/fits/api/hdus.html#astropy.io.fits.PrimaryHDU

@pllim
Copy link
Contributor

pllim commented Sep 20, 2022

Almost there:

stsci/tools/stpyfits.py:docstring of stsci.tools.stpyfits.ConstantValuePrimaryHDU:1:
WARNING: py:class reference target not found: astropy.io.fits.hdu.image.PrimaryHDU

stsci/tools/stpyfits.py:docstring of stsci.tools.stpyfits.ConstantValueImageHDU:1:
WARNING: py:class reference target not found: astropy.io.fits.hdu.image.ImageHDU

@zacharyburnett zacharyburnett merged commit 4b78a2c into spacetelescope:master May 28, 2024
9 checks passed
@zacharyburnett zacharyburnett deleted the rtd_update branch May 28, 2024 17:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pllim pllim pllim left review comments

Assignees

@zacharyburnett zacharyburnett

Labels
documentation tests
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@zacharyburnett @pllim