Move autosummary templates to within the theme #18
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hello. You may have forgotten to update the changelog!
|
josh146
commented
Sep 23, 2022
Mandrenkov
approved these changes
Sep 23, 2022
Comment on lines
+26
to
+27
| To use this in your theme, add the following to your ``conf.py`` | ||
| configuration file: |
There was a problem hiding this comment.
Is it worth mentioning that these templates are included by default?
There was a problem hiding this comment.
Sorry, what do you mean @Mandrenkov? They won't be included by default (unfortunately), since you'll need to configure your own conf.py to set the template path.
As far as I could tell, after browsing the Sphinx dev docs, there is no way of having a HTML theme automatically register new templates
Co-authored-by: Mikhail Andrenkov <Mandrenkov@users.noreply.github.com>
Co-authored-by: Mikhail Andrenkov <Mandrenkov@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context: Currently, all projects using this theme need to duplicate the autosummary templates manually.
Description of the Change: Moves the autosummary templates to within the theme package.
Benefits: Reduction in code and setup for packages
Possible Drawbacks: Only a minor one;
importlib.resourceshas only been added by Python 3.10ish, so we need to installimportlib_resourcesfor backwards compatibility. This is the official recommended approach by PyPA.Related GitHub Issues: n/a