Introduce the use of Mermaidjs for diagrams, and demonstrate it in our deploy docs #320
Conversation
Explain use of gunicorn, and dramatiq
|
|
| @@ -46,6 +47,7 @@ requests = ">=2" | |||
| whitenoise = { extras = ["brotli"], version = "==4.1.4" } | |||
| db-to-sqlite = "*" | |||
| sqlite-utils = "*" | |||
| sqlalchemy = "~=1.4" | |||
There was a problem hiding this comment.
there is a new version of sqlalchemy out, that breaks things. We pin the pipfile to avoid this heartache
| @@ -29,7 +29,7 @@ | |||
| # Add any Sphinx extension module names here, as strings. They can be | |||
| # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | |||
| # ones. | |||
| extensions = ["myst_parser"] | |||
| extensions = ["myst_parser", "sphinxcontrib.mermaid"] | |||
|
|
|||
| # Add any paths that contain templates here, relative to this directory. | |||
| templates_path = ["_templates"] | |||
There was a problem hiding this comment.
Hi @mrchrisadams!
We've talked about this some while ago and it is really nice that you managed to get this working 😄.
As a small comment I would suggest - and I think you might agree and like this - to add a theme. As of now it still looks a bit dull with the default option, but it seems that Mermaid allows for multiple themes (including a green one!).
Check this out:
- Download theme here and refer to them in the docs/config file.
- Stackoverflow thread
There was a problem hiding this comment.
Oh neat, I didn't know mermaid did themes!
I'll have a quick look - if it's not much more work, and sphinx supports it I'll try adding it, otherwise I'll make a separate issue, as the functionality of having diagrams was the key idea.
There was a problem hiding this comment.
hmm… this looks a bit more complicated than I thought, @roald-teunissen. I'd prefer to merge this in and pick up this work another time. The issue for it is below.
This PR adds some more documentation to our deployment process and introduces mermaid to make diagrams with code easily, without being a designer.
You can play with mermaidjs using the live editor at the link below, to get an idea of what the diagrams look like:
https://mermaid.live/