-
Notifications
You must be signed in to change notification settings - Fork 468
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
Where is the pint API? Please add link on main documentation page #1284
Comments
+1 to this - I also find it really frustrating when trying to do development work that involves pint. Developer documentation should also ideally include textual sections aimed at a more advanced audience, describing things like the class hierarchy, for example. |
This would be a critical component to include with the doc updates of #972, though, would there be an easy way to have a stop-gap fix in the current theme configuration now? And, yeah, things like the class hierarchy are really buried and hard to find at the moment. |
I'll see what I can do. |
Thanks @jthielen - even just making a developers page with links to other pages with things like the class heirarchy would be helpful for now! |
this exists now |
Every time I search the pint docs, I cannot for the life of me find a complete API reference. For example, right now I am looking for the testing functions available via pint and cannot find them. I found it once, and I really should bookmark it. EDIT: I have since found it here.
What I expect, as a developer, is on the left-hand side under the "About Pint" section to see something along the lines of "Developer Reference" or "API". I don't see any such link, and it was incredibly frustrating to find the one time I managed to find it. I expect to see it regardless of the page I am on in the documentation. For example, on numpy's documentation there is a nice big juicy "API Reference" prominently displayed at the top of the page near the menu. Same with pandas and matplotlib Please add this :) Thanks!
The text was updated successfully, but these errors were encountered: