Skip to content

docs: Improve readablity and styling of the compatibility matrix' legend #1016

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

docs: Improve readablity and styling of the compatibility matrix' legend #1016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f65218
Fix line breaks in compatibility legend
lord-haffi Jul 31, 2025
95770ed
Improve readablity and look and feel
lord-haffi Jul 31, 2025
d303045
Fix .gitignore
lord-haffi Jul 31, 2025
2542a58
Include custom CSS
lord-haffi Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,8 @@ Temporary Items
# This directory rebuilds on 'tox -e docs' therefore not needed in repo
docs/api
docs/plantuml.jar
docs/_static
docs/compatibility_matrix.csv
docs/_static/images
docs/_static/tables

# version number for bo4e-python; gets auto-generated during the command
# python -m build
Expand Down
18 changes: 18 additions & 0 deletions docs/_static/css/colors.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@

:root {
/* These colors should stay consistent with the colors used in the CLI:
https://github.com/bo4e/BO4E-CLI/blob/main/src/bo4e_cli/io/console/style.py#L238 */
--main-color: #8cc04d;
--sub-color: #617d8b;
--error-color: #e35b3a;
}

.main-color {
color: var(--main-color);
}
.sub-color {
color: var(--sub-color);
}
.error-color {
color: var(--error-color);
}
5 changes: 5 additions & 0 deletions docs/_static/css/override.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@

.rst-content table .line-block:last-child {
/* Remove the margin-bottom from the line-blocks inside tables. Example in changelog.rst. */
margin-bottom: 0;
}
44 changes: 21 additions & 23 deletions docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,27 @@ You can also download the compatibility matrix as CSV file `here <_static/tables
.. table:: Legend for compatibility matrix
:widths: 10 90

+------+------------------------------------------------------+
| Icon | Description |
+======+======================================================+
| 🟢 | Compatible |
| | No changes in the data model |
+------+------------------------------------------------------+
| 🟡 | Compatible |
| | Only non-critical changes in the data model |
| | e.g. added fields, changed doc strings |
+------+------------------------------------------------------+
| 🔴 | Incompatible |
| | Critical changes in the data model |
| | e.g. removed fields, changed types |
+------+------------------------------------------------------+
| ➕ | Compatible |
| | Data model was added in this version |
+------+------------------------------------------------------+
| ➖ | Incompatible |
| | Data model was removed in this version |
+------+------------------------------------------------------+
| \- | Data model not existent in this version |
| | was removed before or will be added in future |
+------+------------------------------------------------------+
+------+---------------------------------------------------------------------------------------------------+
| Icon | Description |
+======+===================================================================================================+
| 🟢 | | :main-color:`Compatible` |
| | | No changes in the data model |
+------+---------------------------------------------------------------------------------------------------+
| 🟡 | | :main-color:`Compatible` |
| | | Only non\-critical changes in the data model e.g. added fields, changed doc strings |
+------+---------------------------------------------------------------------------------------------------+
| 🔴 | | :error-color:`Incompatible` |
| | | Critical changes in the data model e.g. removed fields, changed types |
+------+---------------------------------------------------------------------------------------------------+
| ➕ | | :main-color:`Compatible` |
| | | Data model was added in this version |
+------+---------------------------------------------------------------------------------------------------+
| ➖ | | :error-color:`Incompatible` |
| | | Data model was removed in this version |
+------+---------------------------------------------------------------------------------------------------+
| \- | | Non\-existent |
| | | Doesn't exist in this version i.e. it was removed before or will be added in future |
+------+---------------------------------------------------------------------------------------------------+

.. csv-table:: Compatibility matrix
:file: _static/tables/compatibility_matrix.csv
Expand Down
10 changes: 10 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,16 @@ def setup(app):
"titles_only": False,
}

html_css_files = [
"css/override.css",
"css/colors.css",
]
rst_prolog = """
.. role:: main-color
.. role:: sub-color
.. role:: error-color
"""

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

Expand Down
Loading