Skip to content

docs: add architecture guide to developer docs #1624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marcus-oscarsson merged 4 commits into from
Jul 8, 2026
Merged

docs: add architecture guide to developer docs #1624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0fc661c
docs: add architecture guide to developer docs
hedi-tej Jun 10, 2026
a3ec276
docs: enable Mermaid fenced blocks in Sphinx
hedi-tej Jun 12, 2026
9e3c1f8
docs: replace FastAPI mentions with Flask in architecture
hedi-tej Jun 12, 2026
cf55aa9
docs: refine architecture guide after PR review
hedi-tej Jul 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,12 @@
"fieldlist",
)

# Allow GitHub-style fenced blocks like ```mermaid to be parsed as
# ``{mermaid}`` directives so diagrams render in Sphinx/RTD.
myst_fence_as_directive = [
"mermaid",
]

Comment on lines +112 to +117

@mockoocy mockoocy Jun 12, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well found :)

Image

Renders perfectly now.


# -- Options for sphinxcontrib.mermaid
# https://pypi.org/project/sphinxcontrib-mermaid/
Expand Down
Loading
Loading