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

add pyarrow sphinx intersphinx_mapping #7612

Merged
merged 2 commits into from Apr 28, 2021

Conversation

raybellwaves
Copy link
Member

I'm and hoping to add a link to https://arrow.apache.org/docs/python/generated/pyarrow.parquet.ParquetDataset.html#pyarrow.parquet.ParquetDataset
in the See Also of https://docs.dask.org/en/latest/dataframe-api.html#dask.dataframe.read_parquet

My motivation is the pyarrow page has good docs and example of the filters argument. For example, I was looking for an example of how to use in with the filters arg today.

This will also make it easier for people to navigate to that page and update the read_parquet dask docs .

I'm just unsure on how to link as the page is different to packages i've linked before https://github.com/xarray-contrib/xskillscore/blob/main/docs/source/conf.py#L113

I believe the dask docs also requests a .inv in the intersphinx_mapping which is something i'm not familiar with.

If anyone has time would appreciate some help here cc. @jorisvandenbossche

Current the doc build gives

WARNING: failed to reach any of the inventories with the following issues:
intersphinx inventory 'https://arrow.apache.org/docs/python/objects.inv' not fetchable due to <class 'requests.exceptions.HTTPError'>: 404 Client Error: Not Found for url: https://arrow.apache.org/docs/python/objects.inv

It's places the link in the right place (see below) it's just not clickable.

Screenshot from 2021-04-27 12-43-21

@@ -313,6 +313,7 @@
"https://asyncssh.readthedocs.io/en/latest/",
"https://asyncssh.readthedocs.io/en/latest/objects.inv",
),
"pyarrow": ("https://arrow.apache.org/docs/python/", None),
Copy link
Member

Choose a reason for hiding this comment

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

Dropping python/ at the end seems to work for me locally. Could you give this a try?

Suggested change
"pyarrow": ("https://arrow.apache.org/docs/python/", None),
"pyarrow": ("https://arrow.apache.org/docs/", None),

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks. Also worked for me locally

@raybellwaves raybellwaves changed the title WIP: add pyarrow sphinx intersphinx_mapping add pyarrow sphinx intersphinx_mapping Apr 27, 2021
Copy link
Member

@jrbourbeau jrbourbeau left a comment

Choose a reason for hiding this comment

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

Thanks @raybellwaves!

@jrbourbeau jrbourbeau merged commit bcb2fca into dask:main Apr 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants