From fc1bf17b9c72dc33da56c20336aa37560125cd0b Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Wed, 24 Apr 2024 14:44:43 +0200 Subject: [PATCH] docs: init c4 diagrams --- docs/mkdocs.yml | 8 ++++---- docs/nix/default.nix | 8 +++++++- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 110be3f1..c7fe4868 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -10,19 +10,19 @@ validation: unrecognized_links: warn markdown_extensions: + - admonition - attr_list + - footnotes + - meta + - plantuml_markdown - pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg - - pymdownx.tasklist: custom_checkbox: true - pymdownx.superfences - pymdownx.tabbed: alternate_style: true - - footnotes - - meta - - admonition - pymdownx.details - pymdownx.highlight: use_pygments: true diff --git a/docs/nix/default.nix b/docs/nix/default.nix index f3f16ca9..6d0afd3c 100644 --- a/docs/nix/default.nix +++ b/docs/nix/default.nix @@ -1,11 +1,17 @@ { pkgs, module-docs, ... }: +let + uml-c4 = pkgs.python3Packages.plantuml-markdown.override { plantuml = pkgs.plantuml-c4; }; +in pkgs.stdenv.mkDerivation { name = "clan-documentation"; src = ../.; nativeBuildInputs = - [ pkgs.python3 ] + [ + pkgs.python3 + uml-c4 + ] ++ (with pkgs.python3Packages; [ mkdocs mkdocs-material