-
Notifications
You must be signed in to change notification settings - Fork 415
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
Enable sphinx nitpicky #1147
Conversation
There was a problem hiding this 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.
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 |
f08d559
to
ebfebfa
Compare
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. |
ebfebfa
to
aa59ac8
Compare
6110ac6
to
73d6e3c
Compare
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. |
73d6e3c
to
fa2278b
Compare
fa2278b
to
7757e87
Compare
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