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 xarray to intersphinx_mapping #1074

Open
rocco8773 opened this issue Mar 13, 2021 · 1 comment
Open

Add xarray to intersphinx_mapping #1074

rocco8773 opened this issue Mar 13, 2021 · 1 comment
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org status: on hold Issues & PRs that are being intentionally delayed upstream fix required Issues & PRs that are blocked due to a problem with a dependency

Comments

@rocco8773
Copy link
Member

Since we've started utilizing xarray's we need to add its object mappings to the intersphinx_mapping config variable in /docs/conf.py. This will allow intersphinx to create the appropriate links to associated documentation when we write something like `xarray.DataArray` in the documentation.

@rocco8773 rocco8773 added the docs PlasmaPy Docs at http://docs.plasmapy.org label Mar 13, 2021
@rocco8773 rocco8773 added this to To-Do in Documentation Development via automation Mar 13, 2021
@namurphy namurphy added the upstream fix required Issues & PRs that are blocked due to a problem with a dependency label Jul 18, 2021
@namurphy
Copy link
Member

Adding the "upstream fix required" since (my current understanding is that) xarray needs to make itself compatible with intersphinx before we can do this.

Related to: pydata/xarray#4279

@namurphy namurphy added the status: on hold Issues & PRs that are being intentionally delayed label Sep 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs PlasmaPy Docs at http://docs.plasmapy.org status: on hold Issues & PRs that are being intentionally delayed upstream fix required Issues & PRs that are blocked due to a problem with a dependency
Projects
Development

No branches or pull requests

2 participants