Title: refactor: Stop relying on the template fallback mechanism? · Issue #152 · mkdocstrings/python · GitHub
Open Graph Title: refactor: Stop relying on the template fallback mechanism? · Issue #152 · mkdocstrings/python
X Title: refactor: Stop relying on the template fallback mechanism? · Issue #152 · mkdocstrings/python
Description: 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 mate...
Open Graph Description: 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 p...
X Description: 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 p...
Opengraph URL: https://github.com/mkdocstrings/python/issues/152
X: @github
Domain: patch-diff.githubusercontent.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"refactor: Stop relying on the template fallback mechanism?","articleBody":"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.\r\n\r\nIt might be even more confusing with the [extended templates feature](https://mkdocstrings.github.io/usage/handlers/#handler-extensions) recently introduced by mkdocstrings (which by itself could be a mistake too :see_no_evil:).\r\n\r\nAlso, MkDocs wants to create a new default theme, as well as moving the classic and readthedocs theme out of core, see https://github.com/mkdocs/mkdocs/issues/3636.\r\n\r\nWhat 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`... ","author":{"url":"https://github.com/pawamoy","@type":"Person","name":"pawamoy"},"datePublished":"2024-04-23T19:10:40.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/152/python/issues/152"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:5ff976c9-bef3-6517-e9a8-e7be21fffbad |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 90A4:201EEF:8061691:AABD529:696DFF0A |
| html-safe-nonce | 7a28ec107fffc88dd6cef08ca679d6bebd9362fd7d0c7a81e2ec1ea1f6ccc8a7 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5MEE0OjIwMUVFRjo4MDYxNjkxOkFBQkQ1Mjk6Njk2REZGMEEiLCJ2aXNpdG9yX2lkIjoiMTI3Njk3NzMzMTkwMjg3MTE0IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | cb14813ddeb08b73c78ce46c78423942304afb3be418a898341c0fbad0a50159 |
| hovercard-subject-tag | issue:2259590315 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/mkdocstrings/python/152/issue_layout |
| twitter:image | https://opengraph.githubassets.com/edc962806d0ff2bd8f861672c04c4c5e4182cbcd1a71da4d48833242fc241ab5/mkdocstrings/python/issues/152 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/edc962806d0ff2bd8f861672c04c4c5e4182cbcd1a71da4d48833242fc241ab5/mkdocstrings/python/issues/152 |
| og:image:alt | 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 p... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | pawamoy |
| hostname | github.com |
| expected-hostname | github.com |
| None | 4922b452d03cd8dbce479d866a11bc25b59ef6ee2da23aa9b0ddefa6bd4d0064 |
| turbo-cache-control | no-preview |
| go-import | github.com/mkdocstrings/python git https://github.com/mkdocstrings/python.git |
| octolytics-dimension-user_id | 75664361 |
| octolytics-dimension-user_login | mkdocstrings |
| octolytics-dimension-repository_id | 422878404 |
| octolytics-dimension-repository_nwo | mkdocstrings/python |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 422878404 |
| octolytics-dimension-repository_network_root_nwo | mkdocstrings/python |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 7e5ae23c70136152637ceee8d6faceb35596ec46 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width