MetPy
MetPy copied to clipboard
Unidata
Enable sphinx nitpicky
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
- [x] Closes #1122
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.
I think the pint issues will be resolved by https://github.com/hgrecco/pint/pull/880, as all classes/objects will be moved to the top-level namespace for intersphinx.
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.
