pint-pandas icon indicating copy to clipboard operation
pint-pandas copied to clipboard

Difficult to find docs

Open kenahoo opened this issue 1 year ago • 5 comments

The main docs https://pint-pandas.readthedocs.io/en/docs/ don't seem to be linked on either https://github.com/hgrecco/pint-pandas/blob/master/README.rst or https://pypi.org/project/Pint-Pandas/ , so they're somewhat difficult to find.

For example, both https://pint.readthedocs.io/en/0.10.1/pint-pandas.html and https://pint.readthedocs.io/en/0.18/pint-pandas.html appear in Google results for "pint-pandas docs" before the real docs do (I haven't actually found the real docs in the results), but those are old and have some out-of-date content.

I'm also not quite sure whether https://pint-pandas.readthedocs.io/en/docs/ is really the latest generation of docs, since they say pint-pandas 0.1.dev359+g64017fc documentation in the upper-left corner, do they need to be regenerated? Or are the latest docs actually somewhere else?

kenahoo avatar Nov 28 '23 18:11 kenahoo

something needs changing in the config so the docs generate correctly - the link should be https://pint-pandas.readthedocs.io/en/latest/

andrewgsavage avatar Nov 29 '23 13:11 andrewgsavage

pint-pandas.readthedocs.io now works, still need to add it to places to make it findable

andrewgsavage avatar Nov 29 '23 15:11 andrewgsavage

added it to the readme

@hgrecco could you add http://pint-pandas.readthedocs.io/ to the about section on the github repo page?

andrewgsavage avatar Nov 29 '23 15:11 andrewgsavage

I'm not sure what's going on with the version but that is the latest docs

andrewgsavage avatar Nov 29 '23 16:11 andrewgsavage

Thanks Andrew!

kenahoo avatar Nov 29 '23 16:11 kenahoo