From 5fa5d38810d7711374517dda026ecaf9c5cd8efe Mon Sep 17 00:00:00 2001 From: kevin rajan Date: Tue, 2 Dec 2025 10:49:40 -0600 Subject: [PATCH] Enable Mermaid diagram rendering in Sphinx documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add sphinxcontrib-mermaid extension to conf.py - Configure myst_fence_as_directive to recognize ```mermaid blocks - Add sphinxcontrib-mermaid dependency to Pipfile Mermaid flowcharts now render properly instead of displaying as text. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- docs/Pipfile | 1 + docs/conf.py | 3 +++ 2 files changed, 4 insertions(+) diff --git a/docs/Pipfile b/docs/Pipfile index 3f2c19f..f138bc1 100644 --- a/docs/Pipfile +++ b/docs/Pipfile @@ -6,6 +6,7 @@ name = "pypi" [packages] sphinx = "*" myst-parser = "*" +sphinxcontrib-mermaid = "*" revitron-sphinx-theme = {git = "https://github.com/revitron/revitron-sphinx-theme.git", ref = "master"} linkify-it-py = "*" diff --git a/docs/conf.py b/docs/conf.py index 1e525fb..b7ad9c8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -18,12 +18,15 @@ extensions = [ 'myst_parser', # Markdown support + 'sphinxcontrib.mermaid', # Mermaid diagram support 'sphinx.ext.githubpages', # Create .nojekyll file for GitHub Pages 'sphinx.ext.intersphinx', # Link to other projects' documentation 'sphinx.ext.todo', # Support for todo items ] # MyST-Parser configuration - enable all features +myst_fence_as_directive = ["mermaid"] # Render ```mermaid blocks as Mermaid diagrams + myst_enable_extensions = [ "amsmath", "colon_fence",