search

pulp / pulp-docs

Python Package to help aggregating Pulp's multirepo ecosystem into a unified doc.
https://pedro-psb.github.io/pulp-docs/
2 stars 4 forks source link

Add support for diagram rendering #8

Closed pedro-psb closed 7 months ago

pedro-psb commented 7 months ago

Some repositories currently using Sphinx use plantUML and we'll continue supporting those.

A good candidate is https://github.com/MikhailKravets/mkdocs_puml

pedro-psb commented 7 months ago

https://github.com/MikhailKravets/mkdocs_puml requires a running server to process the diagram, either their external web server or a local docker one.

I'd prefer not to do that.

Alternatives:

  1. Use pre-rendered images for diagrams (sounds ok, we don't seems to diagram or change diagrams that much)
  2. Find a tool that doesn't require a running servers
pedro-psb commented 7 months ago

Mermaid.js is supported out-of-the box: https://squidfunk.github.io/mkdocs-material/reference/diagrams/#diagrams I feel like it's worth converting existing plantUml diagrams to mermaid diagrams.