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

regression in 2.1.0 on using template for class properties in autodoc #6700

Open
mattip opened this issue Sep 12, 2019 · 1 comment
Open

Comments

@mattip
Copy link

mattip commented Sep 12, 2019

In NumPy we use templating for autosummary generation of classes, methods, attributes, and members. These templates live in /_templates/autosummary. Up through v2.1.2, this worked fine. In 2.2.0 class property autosummaries are no longer rendered via the attribute template. The other templates do seem to be used.

See numpy/numpy#14356. I would not wish upon you to try to replicate this, but am willing to try to create a small reproducer if needed. The change seems to be in the changes around generate_autosummary_docs, maybe.

@mattip mattip changed the title regression in 2.2.0 on using template for class properties in autodoc regression in 2.1.0 on using template for class properties in autodoc Sep 15, 2019
@mattip
Copy link
Author

mattip commented Sep 15, 2019

It seems a property used to be templated with attribute.rst, now it is only templated through base.rst. The change first appears in 2.1.0

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

No branches or pull requests

2 participants