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

Remove noindex option under geopandas section so that permalinks work #130

Merged
merged 5 commits into from
Jun 10, 2022
Merged

Remove noindex option under geopandas section so that permalinks work #130

merged 5 commits into from
Jun 10, 2022

Conversation

weiji14
Copy link
Contributor

@weiji14 weiji14 commented Jun 9, 2022

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:

Screenshot at 2022-06-09 11-34-53

And you can then click on https://pyogrio--130.org.readthedocs.build/en/130/api.html#pyogrio.read_dataframe!

Allow for intersphinx to link to read_dataframe and write_dataframe.
@brendan-ward
Copy link
Member

@weiji14 this passed all tests; is it ready for review?

@weiji14 weiji14 marked this pull request as ready for review June 9, 2022 15:53
@weiji14
Copy link
Contributor Author

weiji14 commented Jun 9, 2022

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 .. automodule:: pyogrio), but it should be https://pyogrio--130.org.readthedocs.build/en/130/api.html#module-pyogrio.geopandas instead.

@weiji14
Copy link
Contributor Author

weiji14 commented Jun 9, 2022

Oh wait, now the docs say pyogrio.geopandas.read_dataframe which is probably not what we want. Hold on, give me a few more minutes to look at https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-automodule

@jorisvandenbossche
Copy link
Member

Yes, we would prefer to use the public "pyogrio.read_dataframe" path being shown

@weiji14 weiji14 marked this pull request as draft June 9, 2022 16:01
@brendan-ward brendan-ward added this to the Version 0.4.0 milestone Jun 9, 2022
@weiji14 weiji14 marked this pull request as ready for review June 9, 2022 16:09
docs/source/api.rst Outdated Show resolved Hide resolved
Co-authored-by: Martin Fleischmann <martin@martinfleischmann.net>
Copy link
Member

@martinfleis martinfleis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@martinfleis martinfleis merged commit 7fa0ded into geopandas:main Jun 10, 2022
@weiji14 weiji14 deleted the remove-noindex branch June 10, 2022 12:44
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 this pull request may close these issues.

None yet

4 participants