Skip to content

Relationships

Every relationship in py-doc. Each arrow in a diagram has a row here.

Source Destination Description Technology
Analysis Linter Lints the sources with
Author Commands Runs py-doc commands Terminal
Author Structurizr Local Views the model and arranges its views Browser, HTTP
Author VS Code extension Writes and previews documents in VS Code
Build pipeline Build report Records what it built in
Build pipeline C4 integration Asks for the chapters of a structurizr source
Build pipeline Diagram renderer Has the diagrams drawn by
Build pipeline Pandoc engine Has each output written by
C4 integration Caches Keeps exports and chapters in Files
C4 integration Structurizr Local Starts, and has the views drawn by Docker, HTTP
C4 integration Tool runner Runs structurizr-cli and Chromium through
CI pipeline Commands Runs builds and lint checks Shell
Commands Analysis Counts, checks and compares documents with
Commands Build pipeline Builds documents with
Commands C4 integration Checks, exports and edits models with
Commands Configuration Loads the project from
Commands Content generators Runs the content generators with
Commands HTML deck Builds HTML decks with
Commands Image command Draws image files with
Commands Importers Imports files with
Commands Linter Checks the writing with
Commands Live preview Runs –watch with
Commands Poster builder Builds posters with
Commands Project scaffold Starts projects with
Commands Site generator Makes sites with
Diagram renderer Caches Keeps pictures in Files
Diagram renderer Poster builder Draws poster blocks in documents with
Diagram renderer Tool runner Runs the diagram tools through
HTML deck Poster builder Draws each slide with
HTML deck Tool runner Prints its PDF with Chromium through
Icons Package registries Downloads the icon packs from HTTPS
Image command Diagram renderer Draws with
Importers Tool runner Converts EMF and WMF pictures through
Linter Tool runner Runs markdownlint and Vale through
Live preview Build pipeline Builds each document and its HTML twin with
Live preview Caches Keeps the HTML twins in Files
Live preview HTML deck Shows a deck’s slides with
Live preview Poster builder Builds each poster with
Pandoc engine Tool runner Runs pandoc and XeLaTeX through
Pandoc engine Word and PowerPoint Writes files for .docx, .pptx
Poster builder Diagram renderer Has its diagram fences and plots drawn by
Poster builder Icons Draws the icons of blocks with
Poster builder Tool runner Prints its PDF with Chromium through
Project scaffold Site generator Makes the site project with
Reader Word and PowerPoint Opens the documents in
Science image Tool image Is built on
Site generator Build pipeline Prepares each page with
Site generator Content generators Runs the content generators first with
Site generator Diagram renderer Has the diagrams drawn as SVG by
Site generator Tool runner Runs pandoc, MkDocs and Astro through
Tool image Package registries Is built from, and site builds download from HTTPS
Tool image Structurizr Local Opens the diagrams in headless Chromium HTTP on the shared network
Tool runner Science image Starts a container of, for a scientific fence, building it first Docker Engine, WSL 2 on Windows
Tool runner Tool image Starts a container of Docker Engine, WSL 2 on Windows
VS Code extension Commands Starts py-doc docx, slides or poster –watch for the open file Child process
VS Code extension Live preview Shows the served preview from HTTP on 127.0.0.1