-
Notifications
You must be signed in to change notification settings - Fork 22
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
Remove noindex option under geopandas section so that permalinks work #130
Conversation
Allow for intersphinx to link to read_dataframe and write_dataframe.
@weiji14 this passed all tests; is it ready for review? |
Yep, just another one-line commit. Noticed that the "Geopandas integration" subsection had a permalink like https://pyogrio--130.org.readthedocs.build/en/130/api.html#module-0 (due to duplicate use of |
Oh wait, now the docs say |
Yes, we would prefer to use the public "pyogrio.read_dataframe" path being shown |
Ok, things look better now, just needed to use |
Co-authored-by: Martin Fleischmann <martin@martinfleischmann.net>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Hi there, I was trying to add an intersphinx link using "py:func:`pyogrio.read_dataframe`" at weiji14/zen3geo#19 (comment) but it seems like there wasn't a permalink available. The closest link I could find was https://pyogrio.readthedocs.io/en/latest/api.html#geopandas-integration, but ideally it would be possible to link directly to
pyorgio.read_dataframe
.This Pull Request removes the
:noindex:
option added in #18 (specifically at commit 679b81b) so that intersphinx will work and the permalink shows up, like so:And you can then click on https://pyogrio--130.org.readthedocs.build/en/130/api.html#pyogrio.read_dataframe!