Looking for tool to use for a documentation website #1249
Unanswered
edvardfagerholmsc
asked this question in
Q&A
Replies: 1 comment 1 reply
-
Many people are using https://mermaid.js.org/ for diagrams. There are a Sphinx extension to support mermaid.js https://pypi.org/project/sphinxcontrib-mermaid/. |
Beta Was this translation helpful? Give feedback.
1 reply
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
I'm trying to improve some documentation and would like to find the right tool for the job. Currently the docs are in Confluence, which I hate for many reasons. I've written some other documentation using Jekyll, but noticed this option too.
I have certain requirements:
My understanding is that (2) works somewhat out-of-the-box. LaTeX has
pgf-umlsd
, which looks reasonably simple for making sequence diagrams that other can copy paste and edit. How hard is configuring (3)? I couldn't immediately find any documentation.Any tutorials that would cover all the steps? Some jekyll plugins also support local searching of the generated page. Would anything similar exist for Jupyter Books?
Beta Was this translation helpful? Give feedback.
All reactions