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.

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

Enable sphinx nitpicky #1147

Merged
merged 4 commits into from
Sep 30, 2022
Merged

Enable sphinx nitpicky #1147

merged 4 commits into from
Sep 30, 2022

Conversation

zbruick
Copy link
Contributor

@zbruick zbruick commented Sep 5, 2019

Description Of Changes

Had fun playing whack-a-mole to enable nitpicky for sphinx. This is going to be a good thing to have to clean up our docs, as it caught some legitimate typos and inconsistencies that were good to resolve. However, there are some remaining warnings that I can't seem to appease, and I don't necessarily want to throw them in nitpicky_ignore. If anyone has ideas about how to fix them let me know.

The only one that should be silenced, but can't figure out how is default: 'change' with the apostrophes. I think I've tried every combo I know of ", ', and '.

Checklist

@zbruick zbruick added Area: Docs Affects documentation Type: Enhancement Enhancement to existing functionality labels Sep 5, 2019
Copy link
Member

@dopplershift dopplershift left a comment

Choose a reason for hiding this comment

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

This is working out just like I hoped it would. It became a whole lot more manageable now that you fixed the section issues for the calc docs.

metpy/interpolate/points.py Outdated Show resolved Hide resolved
metpy/units.py Outdated Show resolved Hide resolved
metpy/plots/station_plot.py Outdated Show resolved Hide resolved
metpy/interpolate/points.py Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
@zbruick
Copy link
Contributor Author

zbruick commented Sep 5, 2019

Added some more things. Tried playing around with a lot of the remaining warnings and got nowhere on most of them. Sequence doesn't seem to have any variations that sphinx understands. The warnings with interpolation are from functions that are deprecated and will be removed in 0.12 so I'm not too worried about those, since the un-deprecated functions are referencing things fine. The transitive error from traitlets continues. And pint and its classes/methods seem to be unreachable sometimes (but not always). I'll continue investigating, but this gets us ~90% of the way there.

@zbruick
Copy link
Contributor Author

zbruick commented Oct 31, 2019

I think the pint issues will be resolved by hgrecco/pint#880, as all classes/objects will be moved to the top-level namespace for intersphinx.

@dopplershift dopplershift modified the milestones: 0.12, 1.0 Dec 1, 2019
@dopplershift dopplershift modified the milestones: 1.0, 1.1 Jan 10, 2020
Base automatically changed from master to main February 22, 2021 22:39
@dopplershift dopplershift modified the milestones: 1.1.0, 1.2.0 Aug 2, 2021
@dopplershift dopplershift modified the milestones: 1.2.0, 1.3.0 Oct 8, 2021
@dopplershift dopplershift modified the milestones: 1.3.0, May 2022 Mar 31, 2022
@dopplershift dopplershift modified the milestones: May 2022, July 2022 May 16, 2022
@dopplershift
Copy link
Member

3 years later, this is finally ready (ping @dcamron)

There's always a ton more to be polished in the docs, but at least having this enabled will have sphinx checking our references extra hard.

@dopplershift dopplershift merged commit 2ab84a1 into Unidata:main Sep 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Docs Affects documentation Type: Enhancement Enhancement to existing functionality
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Enable sphinx nitpicky on doc builds
3 participants