Skip to content

feature: Support for accessors #229

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

Closed
znicholls opened this issue Jan 17, 2025 · 1 comment
Closed

feature: Support for accessors #229

znicholls opened this issue Jan 17, 2025 · 1 comment
Assignees
Labels
feature New feature or request

Comments

@znicholls
Copy link

Is your feature request related to a problem? Please describe.

If you document accessors, there isn't an obvious solution for how to show the namespace in which the accessor ends up in (as opposed to the original API). In the sphinx world, there is a package dedicated to handling this situation: https://github.com/xarray-contrib/sphinx-autosummary-accessors

Describe the solution you'd like

A similar thing for the mkdocs universe.

Describe alternatives you've considered

Additional context

I have written such an extension here: https://github.com/climate-resource/mkdocstrings-python-accessors. As you can see, it is super basic, but it seems to do what I want (see an example at the bottom of this page , with built docs here (note the namespace which is documented)).

@znicholls znicholls added the feature New feature or request label Jan 17, 2025
@znicholls
Copy link
Author

Sorry, made this from the wrong account, see #230 instead

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants