From a40be5c135ba58f0d22697d207cfbcd4d3ca03b2 Mon Sep 17 00:00:00 2001 From: Leandro Lucarella Date: Thu, 23 Nov 2023 15:43:05 +0100 Subject: [PATCH] Add the `markdown-svgbob` extension This extension allows documentation to include ASCII diagrams/graphs that are rendered as SVG when the documentation is generated, giving a nicer look to the diagrams/graphs while keeping the documents readable in text form. This is especially useful for docstrings, are they will be seen by users in text form, but we still want to render them nicely. Signed-off-by: Leandro Lucarella --- mkdocs.yml | 2 ++ pyproject.toml | 1 + 2 files changed, 3 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index 40676853..4fce883f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,6 +68,8 @@ markdown_extensions: - attr_list - def_list - footnotes + - markdown_svgbob: + min_char_width: 0 - pymdownx.details - pymdownx.highlight: anchor_linenums: true diff --git a/pyproject.toml b/pyproject.toml index 42445300..7e433b22 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -48,6 +48,7 @@ dev-mkdocs = [ "Markdown == 3.5.1", "black == 23.10.1", "frequenz-repo-config[lib] == 0.7.5", + "markdown-svgbob == 202112.1022", "mike == 2.0.0", "mkdocs-gen-files == 0.5.0", "mkdocs-include-markdown-plugin == 6.0.4",