docs: Add extension to filter the lines to show in code

Add the [pymdownx-superfence-filter-lines] markdown extension to be able
to filter the lines to show in code examples.

This is useful when having examples that need to be valid (pass linting
or tests) but still want to avoid showing all the boilerplate to the
user.

[pymdownx-superfence-filter-lines]: https://github.com/frequenz-floss/pymdownx-superfence-filter-lines-python

Signed-off-by: Leandro Lucarella <[email protected]>

Author: llucax

mkdocs.yml

@@ -83,6 +83,10 @@ markdown_extensions:
         - name: mermaid
           class: mermaid
           format: !!python/name:pymdownx.superfences.fence_code_format
+        - name: "*"
+          class: "highlight"
+          format: !!python/name:pymdownx_superfence_filter_lines.do_format
+          validator: !!python/name:pymdownx_superfence_filter_lines.do_validate
   - pymdownx.tabbed
   - pymdownx.tasklist:
       custom_checkbox: true

pyproject.toml

@@ -56,6 +56,7 @@ dev-mkdocs = [
   "mkdocs-macros-plugin == 1.0.5",
   "mkdocs-material == 9.5.6",
   "mkdocstrings[python] == 0.24.0",
+  "pymdownx-superfence-filter-lines == 0.1.0",
 ]
 dev-mypy = [
   # For checking the noxfile, docs/ script, and tests