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

Where is the pint API? Please add link on main documentation page #1284

Closed
edmundsj opened this issue Apr 10, 2021 · 5 comments
Closed

Where is the pint API? Please add link on main documentation page #1284

edmundsj opened this issue Apr 10, 2021 · 5 comments
Labels

Comments

@edmundsj
Copy link

edmundsj commented Apr 10, 2021

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!

@TomNicholas
Copy link
Contributor

+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.

@jthielen
Copy link
Contributor

jthielen commented Jul 3, 2021

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.

@jules-ch
Copy link
Collaborator

jules-ch commented Jul 3, 2021

I'll see what I can do.
We're gonna have to work on the new documentation.

@TomNicholas
Copy link
Contributor

Thanks @jthielen - even just making a developers page with links to other pages with things like the class heirarchy would be helpful for now!

@jules-ch jules-ch added bug docs and removed bug labels Nov 18, 2021
@andrewgsavage
Copy link
Collaborator

this exists now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants