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

use a custom create_documenter function #10

Merged
merged 4 commits into from Aug 7, 2020
Merged

Conversation

keewis
Copy link
Collaborator

@keewis keewis commented Aug 2, 2020

sphinx-doc/sphinx#8038 explores the option to support registering custom get_documenter functions. sphinx recently got support for overriding get_documenter (via the Autosummary.create_documenter method).

This can be used to make sure the accessor documenters are chosen if the corresponding template was specified, making it possible to remove / avoid the ugly hack from #6.

@keewis
Copy link
Collaborator Author

keewis commented Aug 7, 2020

The new sphinx release will include a new Autosummary.create_documenter method (which has been added just for us), so we can remove the hack. Downside is that people using __call__ methods on accessors will see the Alias of ... message for sphinx<3.1.0 (3.1 is covered by the hack). However, this is a pretty new extension so I guess that's okay.

@keewis keewis closed this Aug 7, 2020
@keewis keewis reopened this Aug 7, 2020
@keewis keewis changed the title use the custom get_documenter registry a custom create_documenter function Aug 7, 2020
@keewis keewis changed the title a custom create_documenter function use a custom create_documenter function Aug 7, 2020
@keewis keewis merged commit 899d886 into master Aug 7, 2020
@keewis keewis deleted the custom-get_documenter branch August 7, 2020 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

autosummary hack
1 participant