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

autosummary: Allow customizing template environment #4030

Closed
flying-sheep opened this issue Aug 29, 2017 · 5 comments
Closed

autosummary: Allow customizing template environment #4030

flying-sheep opened this issue Aug 29, 2017 · 5 comments
Labels
Milestone

Comments

@flying-sheep
Copy link
Contributor

flying-sheep commented Aug 29, 2017

the autosummary extension uses this code to create a jinja template environment.

there is no room for customization via conf.py, and users will have to modify e.g. jinja2.defaults.DEFAULT_FILTERS if they want to add filters for autosummary pages.

it would be useful to have customization options like html_context, e.g. for usage like this: readthedocs/readthedocs-sphinx-ext#28

@tk0miya
Copy link
Member

tk0miya commented Apr 24, 2020

+1: Reasonable.

@tk0miya tk0miya added this to the 3.1.0 milestone Apr 24, 2020
@tk0miya
Copy link
Member

tk0miya commented Apr 24, 2020

@flying-sheep Do you still need such a feature? If true, I'll add autosummary_context to add template variables for templates of autosummary.

@flying-sheep
Copy link
Contributor Author

Yes, It would be cleaner to do it that way for sure!

@tk0miya
Copy link
Member

tk0miya commented Apr 24, 2020

Okay, I'll post a PR later.

tk0miya added a commit to tk0miya/sphinx that referenced this issue Apr 24, 2020
tk0miya added a commit that referenced this issue Apr 26, 2020
Close #4030: autosummary: Add autosummary_context
@flying-sheep
Copy link
Contributor Author

Great, thank you!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 25, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

2 participants