Skip to content
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

DOC-252 Fix broken mermaid diagrams in docs #5467

Closed
wants to merge 7 commits into from
Closed

DOC-252 Fix broken mermaid diagrams in docs #5467

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f3a94aa
change diagram format and install npm package to render diagrams
Jun 11, 2024
9dd6498
readthedocs wants a whole number
Jun 11, 2024
2813223
Merge branch 'master' into nikki/docs/fix-mermaid-diagrams
Jun 11, 2024
415edb4
move commands around
Jun 11, 2024
6668ebc
try setting mermaid command location
Jun 11, 2024
4007360
change location of mermaid_cmd if not local build
Jun 11, 2024
0cb167e
check location of mmdc again
Jun 11, 2024
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
3 changes: 3 additions & 0 deletions .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ build:
os: "ubuntu-22.04"
tools:
python: "mambaforge-22.9"
nodejs: "20"
jobs:
post_install:
- cat monodocs-environment.lock.yaml
Expand All @@ -16,6 +17,8 @@ build:
- conda info
- conda env list
- conda list
- npm install -g @mermaid-js/mermaid-cli
- which mmdc

# Build documentation in the docs/ directory with Sphinx
sphinx:
Expand Down
4 changes: 3 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,9 +296,11 @@
myst_enable_extensions = ["colon_fence"]

# Sphinx-mermaid config
mermaid_output_format = "raw"
mermaid_output_format = "png"
mermaid_version = "latest"
mermaid_init_js = "mermaid.initialize({startOnLoad:false});"
if not os.environ.get("MONODOCS_DEV_BUILD"):
mermaid_cmd = "/home/docs/.asdf/shims/mmdc"

# Makes it so that only the command is copied, not the output
copybutton_prompt_text = "$ "
Expand Down
Loading