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

User API - Methods from Accessors are not clickable #654

Closed
erogluorhan opened this issue Jan 10, 2024 · 3 comments · Fixed by #655
Closed

User API - Methods from Accessors are not clickable #654

erogluorhan opened this issue Jan 10, 2024 · 3 comments · Fixed by #655
Assignees
@philipc2
Labels
documentation Improvements or additions to documentation improvement Improvements on existing features or infrastructure
Milestone
Documentation

Comments

@erogluorhan
Copy link
Member

The methods in the user API that belong to an accessor class cannot be clicked and expanded. They should be expandable just like the others.

See an example below:

image
@erogluorhan erogluorhan added documentation Improvements or additions to documentation improvement Improvements on existing features or infrastructure labels Jan 10, 2024
@philipc2
Copy link
Member

philipc2 commented Jan 10, 2024 •
edited
Loading

@dcherian

Do you have any pointers on how this is handled with xarray?

@dcherian
Copy link
Contributor

https://github.com/xarray-contrib/sphinx-autosummary-accessors

@philipc2
Copy link
Member

https://github.com/xarray-contrib/sphinx-autosummary-accessors

Thank you!

@philipc2 philipc2 linked a pull request Jan 10, 2024 that will close this issue
Use sphinx-autosummary-accessors for rendering accessors in API #655
Merged
@philipc2 philipc2 self-assigned this Jan 10, 2024
@philipc2 philipc2 mentioned this issue Jan 11, 2024
Merged
@philipc2 philipc2 added this to the Documentation milestone Mar 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@philipc2 philipc2

Labels
documentation Improvements or additions to documentation improvement Improvements on existing features or infrastructure
Projects
UXarray Development
Status: ✅ Done
Milestone
Documentation
Development

Successfully merging a pull request may close this issue.

Use sphinx-autosummary-accessors for rendering accessors in API UXARRAY/uxarray
3 participants
@dcherian @erogluorhan @philipc2