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 nitpicky mode for building docs #3539

Closed
astrofrog opened this issue Nov 25, 2019 · 2 comments · Fixed by #4178
Closed

Use nitpicky mode for building docs #3539

astrofrog opened this issue Nov 25, 2019 · 2 comments · Fixed by #4178
Labels
Documentation Affects the documentation Effort High Requires a large time investment Package Novice Requires little knowledge of the internal structure of SunPy Priority Low Slow action required

Comments

@astrofrog
Copy link
Contributor

I noticed that Sunpy doesn't currently set nitpicky=True in the sphinx configuration (conf.py). This is a really useful option that ensures that internal and intersphinx references are not broken:

http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpicky
@Cadair
Copy link
Member

Cadair commented Nov 26, 2019 •
edited

We probably need sphinx-doc/sphinx#6861 to be fixed before we can easily turn this on?

@astrofrog
Copy link
Contributor Author

Yes though you could probably also add optional to the list of nitpick exceptions.

@dstansby dstansby added the Documentation Affects the documentation label Nov 30, 2019
@dstansby dstansby mentioned this issue May 16, 2020
Merged
@nabobalis nabobalis added Effort High Requires a large time investment Package Novice Requires little knowledge of the internal structure of SunPy Priority Low Slow action required labels Jul 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Affects the documentation Effort High Requires a large time investment Package Novice Requires little knowledge of the internal structure of SunPy Priority Low Slow action required
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Enable sphinx nitpicky mode dstansby/sunpy
4 participants
@astrofrog @Cadair @nabobalis @dstansby