Embed our "wishlist" branch in the documentation
Marco Ricci commited on 2025-06-01 23:05:23
Zeige 7 geänderte Dateien mit 79 Einfügungen und 0 Löschungen.
The contents of `docs/wishlist/` now host a checkout of the `wishlist` branch, providing our own bug and wish listing. The navigation includes a new section "Wishlist", and the section includes custom CSS styling. The "actions" partial template is also updated so that it generates correct links to the raw file on GitHub, i.e., on the "wishlist" branch instead of on the "master" branch.
- .gitmodules 0000000..40ea689
- docs-overrides/partials/actions.html 0000000..29cbf50
- docs/wishlist 0000000..2fd3558
- docs/wishlist_styling.css 0000000..efb1a7c
- mkdocs.yml c70307b..2ddea97
- mkdocs_devsetup.yml 1645de0..aa9811e
- mkdocs_offline.yml 6647552..8bb901a
| ... | ... |
@@ -0,0 +1,28 @@ |
| 1 |
+{#-
|
|
| 2 |
+ This file is based on an automatically generated file from MkDocs-Material. |
|
| 3 |
+ |
|
| 4 |
+ Changes: |
|
| 5 |
+ |
|
| 6 |
+ - Some entries below the path docs/wishlist/... are actually from |
|
| 7 |
+ a submodule pointing to this same repository, but at the "wishlist" |
|
| 8 |
+ branch. |
|
| 9 |
+-#} |
|
| 10 |
+{% if page.edit_url %}
|
|
| 11 |
+ {% if "content.action.edit" in features %}
|
|
| 12 |
+ <a href="{{ page.edit_url | replace('master/docs/wishlist/', 'wishlist/') }}" title="{{ lang.t('action.edit') }}" class="md-content__button md-icon">
|
|
| 13 |
+ {% set icon = config.theme.icon.edit or "material/file-edit-outline" %}
|
|
| 14 |
+ {% include ".icons/" ~ icon ~ ".svg" %}
|
|
| 15 |
+ </a> |
|
| 16 |
+ {% endif %}
|
|
| 17 |
+ {% if "content.action.view" in features %}
|
|
| 18 |
+ {% if "/blob/" in page.edit_url %}
|
|
| 19 |
+ {% set part = "blob" %}
|
|
| 20 |
+ {% else %}
|
|
| 21 |
+ {% set part = "edit" %}
|
|
| 22 |
+ {% endif %}
|
|
| 23 |
+ <a href="{{ page.edit_url | replace(part, 'raw') | replace('master/docs/wishlist/', 'wishlist/') }}" title="{{ lang.t('action.view') }}" class="md-content__button md-icon">
|
|
| 24 |
+ {% set icon = config.theme.icon.view or "material/file-eye-outline" %}
|
|
| 25 |
+ {% include ".icons/" ~ icon ~ ".svg" %}
|
|
| 26 |
+ </a> |
|
| 27 |
+ {% endif %}
|
|
| 28 |
+{% endif %}
|
| ... | ... |
@@ -0,0 +1 @@ |
| 1 |
+Subproject commit 2fd355826bdf9556c723605a5d0fdfbcdbdba57b |
| ... | ... |
@@ -0,0 +1,34 @@ |
| 1 |
+p:has(+ table#bug-summary) {
|
|
| 2 |
+ margin: 0em; |
|
| 3 |
+} |
|
| 4 |
+table#bug-summary {
|
|
| 5 |
+ width: 100%; |
|
| 6 |
+ border: none; |
|
| 7 |
+} |
|
| 8 |
+table#bug-summary + p {
|
|
| 9 |
+ margin: 0em; |
|
| 10 |
+} |
|
| 11 |
+table#bug-summary th, table#bug-summary td {
|
|
| 12 |
+ padding: 0.25em; |
|
| 13 |
+ border: none; |
|
| 14 |
+} |
|
| 15 |
+table#bug-summary td:first-of-type {
|
|
| 16 |
+ padding-right: 1.5em; |
|
| 17 |
+} |
|
| 18 |
+ |
|
| 19 |
+a.scheduled-next {
|
|
| 20 |
+ font-weight: bold; |
|
| 21 |
+} |
|
| 22 |
+ |
|
| 23 |
+a.scheduled {
|
|
| 24 |
+ font-style: oblique; |
|
| 25 |
+} |
|
| 26 |
+ |
|
| 27 |
+a.unscheduled {
|
|
| 28 |
+ opacity: 0.75; |
|
| 29 |
+} |
|
| 30 |
+a.fixed {
|
|
| 31 |
+ font-weight: normal; |
|
| 32 |
+ font-style: normal; |
|
| 33 |
+ text-decoration: line-through; |
|
| 34 |
+} |
| ... | ... |
@@ -13,6 +13,7 @@ docs_dir: docs |
| 13 | 13 |
site_dir: html |
| 14 | 14 |
extra_css: |
| 15 | 15 |
- mkdocstrings_recommended_styles.css |
| 16 |
+ - wishlist_styling.css |
|
| 16 | 17 |
|
| 17 | 18 |
theme: |
| 18 | 19 |
name: "material" |
| ... | ... |
@@ -120,6 +121,11 @@ nav: |
| 120 | 121 |
- Changelog: changelog.md |
| 121 | 122 |
- Upgrade notes: upgrade-notes.md |
| 122 | 123 |
- Python compatibility: pycompatibility.md |
| 124 |
+ - Wishlist: |
|
| 125 |
+ - wishlist/index.md |
|
| 126 |
+not_in_nav: | |
|
| 127 |
+ wishlist/*.md |
|
| 128 |
+ !wishlist/index.md |
|
| 123 | 129 |
draft_docs: | |
| 124 | 130 |
changelog.d |
| 125 | 131 |
_future.md |
| ... | ... |
@@ -3,6 +3,8 @@ INHERIT: mkdocs_offline.yml |
| 3 | 3 |
draft_docs: '' |
| 4 | 4 |
not_in_nav: | |
| 5 | 5 |
changelog.d |
| 6 |
+ wishlist/*.md |
|
| 7 |
+ !wishlist/index.md |
|
| 6 | 8 |
|
| 7 | 9 |
nav: |
| 8 | 10 |
- Overview: index.md |
| ... | ... |
@@ -52,3 +54,5 @@ nav: |
| 52 | 54 |
- Upgrade notes: upgrade-notes.md |
| 53 | 55 |
- Python compatibility: pycompatibility.md |
| 54 | 56 |
- Future ideas: _future.md |
| 57 |
+ - Wishlist: |
|
| 58 |
+ - wishlist/index.md |