Repository navigation
Conversation
Signed-off-by: Haowei Hsu <hwhsu1231@localizethedocs.org>
Documentation build overview
|
|
What's the motivation for this change? No user-facing changes, just to delete this line of config? templates_path = [os.fspath(_PSE_PATH / "pep_theme" / "templates")]This is the same as #4404, which was closed because:
What has changed since then? |
This is because the current configuration is redundant. We just need to place the Jinja templates directly under the theme directory (instead of inside an internal Then, by simply specifying |
|
I don't mind much either way, but Adam wasn't keen last year and I don't see a new reason to change it now. Thanks anyway. |
|
@hugovk Actually, I'd rather ask: why did the maintenance team deliberately create a After all, even the built-in themes provided in the sphinx-doc/sphinx project demonstrate placing Jinja templates directly under the theme name directory. For example: In addition, those well-known third-party themes also store Jinja templates following this convention. For example: |
|
I don't know, but as mentioned, this theme is internal-only and not for re-use, unlike the seven mentioned. |
|
Even if it's not intended for external use, custom themes meant strictly for internal use basically also place Jinja templates directly under the theme name directory. For example:
Therefore, that's why I believe the current layout used by |
|
Is there any benefit for us, apart from being "like other projects"? |
This is like wanting to calculate Normally, we would simply change While the resulting value of |
|
@hwhsu1231 I still don't see any new reason, or benefit other than dropping a line of config and being like other projects, so let's just drop this idea. |
|
@hugovk Just to be clear, I don't mean any offense by this, but could you please answer a question for me first? As in the analogy I brought up in #5197 (comment), the current way Jinja templates are handled is essentially equivalent to writing |
|
I think we've discussed this long enough, thanks. |
This is a follow-up to #4404, closed on the grounds that the PEPs theme is internal-only and not intended to be overridden. That stands: this change is not about making the theme user-overridable. It is about the redundant configuration that using the theme's own templates through
templates_pathrequires.This PR moves the theme's Jinja templates from
pep_theme/templates/up topep_theme/, drops thetemplates_pathentry inpeps/conf.pythat existed only to point Sphinx at them, and also updatespeps/docs/rendering_system.rst, which referred to the old template path.