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.

Sign up for GitHub

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

Jump to bottom

In docs link to external types #43

Closed
sverhoeven opened this issue Apr 8, 2021 · 2 comments
Closed

In docs link to external types #43

sverhoeven opened this issue Apr 8, 2021 · 2 comments
Milestone
Updated API for t...

Comments

@sverhoeven
Copy link
Member

Use intersphinx to link to numpy, xarray, grpc4bmi types.
@Peter9192
Copy link
Collaborator

Yes, good idea. Example of how this is done in ESMValTool:

https://github.com/ESMValGroup/ESMValTool/blob/b2e0cd8cafc805ec32fdd538a0a9d74714cabc6b/doc/sphinx/source/conf.py#L422-L437

sverhoeven added a commit that referenced this issue Jul 8, 2021
@sverhoeven
Add link to Path in docstring + added intersphinx
5ed4a31 
Refs #43
@Peter9192
Copy link
Collaborator

Added in #143

@Peter9192 Peter9192 added this to the Tech paper milestone Jul 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Updated API for tech paper and v1.0.0
Development

No branches or pull requests
2 participants
@sverhoeven @Peter9192