hgrecco / pint-pandas

Pandas support for pint
Other
166 stars 40 forks source link

Difficult to find docs #209

Open kenahoo opened 7 months ago

kenahoo commented 7 months ago

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?

andrewgsavage commented 7 months ago

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

andrewgsavage commented 7 months ago

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

andrewgsavage commented 7 months ago

added it to the readme

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

andrewgsavage commented 7 months ago

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

kenahoo commented 7 months ago

Thanks Andrew!