Skip to content

Dev #54

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
kvnloo merged 2 commits into from
Dec 2, 2025
Merged

Dev #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5fa5d38
Enable Mermaid diagram rendering in Sphinx documentation
kvnloo Dec 2, 2025
9a561e2
Merge pull request #53 from kvnloo/docs-consolidation
kvnloo Dec 2, 2025
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
1 change: 1 addition & 0 deletions docs/Pipfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "*"

Expand Down
3 changes: 3 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading