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

refactor: Stop relying on the template fallback mechanism? #152

Open
pawamoy opened this issue Apr 23, 2024 · 0 comments
Open

refactor: Stop relying on the template fallback mechanism? #152

pawamoy opened this issue Apr 23, 2024 · 0 comments
Assignees
Labels
templates Jinja templates

Comments

@pawamoy
Copy link
Member

pawamoy commented Apr 23, 2024

The fallback mechanism is sometimes confusing when overriding templates and using a theme different than the fallback one. For example if one uses the nature theme, they have to use nature in the path of custom templates, instead of material, even if the nature theme doesn't even exist in mkdocstrings-python's sources.

It might be even more confusing with the extended templates feature recently introduced by mkdocstrings (which by itself could be a mistake too 🙈).

Also, MkDocs wants to create a new default theme, as well as moving the classic and readthedocs theme out of core, see mkdocs/mkdocs#3636.

What I suggest for mkdocstrings, or mkdocstrings-python at least in the short term, is that we stop relying on the fallback mechanism, and either entirely support a theme, or not at all, whether directly in mkdocstrings-python's sources, or in external packages. I'm not sure yet how we would handle dependencies then: mkdocstrings, mkdocstrings-python, mkdocstrings-python-material...

@pawamoy pawamoy added the unconfirmed This bug was not reproduced yet label Apr 23, 2024
@pawamoy pawamoy self-assigned this Apr 23, 2024
@pawamoy pawamoy added templates Jinja templates and removed unconfirmed This bug was not reproduced yet labels Apr 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
templates Jinja templates
Projects
None yet
Development

No branches or pull requests

1 participant