py-doc
The C4 model of py-doc, the Markdown technical documentation toolset.
The system landscape of py-doc: the people and systems around it.
View: SystemContext
py-doc, the people who use it and the systems around it.
People
| Name | Description | Tags |
|---|---|---|
| Author | Writes technical documentation in Markdown and builds it into Word, PowerPoint, PDF, HTML and web sites. | |
| Reader | Reads the documents and sites that py-doc builds. |
Software systems
| Name | Description | Tags |
|---|---|---|
| CI pipeline | Runs the same build and lint commands on every change, such as GitHub Actions. | External |
| Package registries | Docker Hub, GitHub releases, PyPI and npm: where the tool image and site builds download their tools. | External |
| py-doc | Turns Markdown into Word, PowerPoint, PDF, HTML and web sites, checks the writing, and documents C4 models. | |
| Word and PowerPoint | Open the built documents and decks, and are where documents start before py-doc imports them. | External |