Dynamic behaviour

How the parts of py-doc work together, step by step.

View: Build

How py-doc build makes one Word document.

1. Author to Commands: py-doc build guide
2. Commands to Configuration: Loads py-doc.yml
3. Commands to Build pipeline: Builds the guide
4. Build pipeline to Diagram renderer: Draws the diagram fences
5. Diagram renderer to Tool runner: Runs PlantUML, Mermaid and the rest
6. Build pipeline to Pandoc engine: Writes the Word file
7. Pandoc engine to Tool runner: Runs pandoc
8. Build pipeline to Build report: Records the outputs

View: LivePreview

How the VS Code extension shows a live preview of a Word document.

1. Author to VS Code extension: Clicks the eye button
2. VS Code extension to Commands: py-doc docx guide.md –watch
3. Commands to Live preview: Watches guide.md
4. Live preview to Build pipeline: Builds guide.docx and its HTML twin
5. Live preview to Caches: Writes the twin to .py-doc/preview
6. VS Code extension to Live preview: Shows the twin, which reloads on every save