Skip to content

Removed autosummary non existing templates #13496

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
wants to merge 1 commit into from

Conversation

fconil
Copy link
Contributor

@fconil fconil commented Apr 23, 2025

Purpose

Reading autosummary extension documentation, "Customizing templates", I noticed some of the templates files described did not exist in sphinx/ext/autosummary/templates/autosummary/.

  • autosummary/function.rst – template for functions
  • autosummary/attribute.rst – template for class attributes
  • autosummary/method.rst – template for class methods

This pull request removed this part from the autosummary documentation page.

@AA-Turner
Copy link
Member

I think this is trying to say that if you want to add your own templates, these are the ones that autosummary will look for, rather than that these are the default templates. I agree it is somewhat unclear, though.

A

@AA-Turner AA-Turner closed this Jul 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants