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

Difficult to find docs #209

Open
kenahoo opened this issue Nov 28, 2023 · 5 comments · Fixed by #210
Open

Difficult to find docs #209

kenahoo opened this issue Nov 28, 2023 · 5 comments · Fixed by #210

Comments

@kenahoo
Copy link

kenahoo commented Nov 28, 2023

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
Copy link
Collaborator

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

@andrewgsavage
Copy link
Collaborator

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

@andrewgsavage
Copy link
Collaborator

added it to the readme

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

@andrewgsavage
Copy link
Collaborator

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

@kenahoo
Copy link
Author

kenahoo commented Nov 29, 2023

Thanks Andrew!

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

Successfully merging a pull request may close this issue.

2 participants