1930704 - Mermaid diagram with empty classes fails to build in source docs but works on mermaid.live

Status: REOPENED

(Developer Infrastructure :: Source Documentation, defect)

Description

[Paul Zühlcke [:pbz]]

I'm trying to add the following Mermaid diagram to source docs: https://gist.github.com/Trikolon/a7d0c4e5f32d92398efa757311153c4d

This diagram works just fine on mermaid.live, but it leads to a build error when I add it to the source docs: Syntax error in text.

Could the issue be that our mermaidjs version is outdated? Our version is currently 10.2.0 while the latest version is 11.4.0.

Comment 1

[Sylvestre Ledru [:Sylvestre]]

Attachment: Bug 1930704 - doc: update to mermaid 1.0.0 r?#firefox-source-docs-reviewers

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/3dae861bca6e
doc: update to mermaid 1.0.0 r=firefox-source-docs-reviewers,ahal DONTBUILD

Comment 3

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/3dae861bca6e

Comment 4

[Paul Zühlcke [:pbz]]

Thanks for the update!

Unfortunately the issue persists. The error message is: "Syntax error in text mermaid version 11.2.0".
I've tested locally with Mermaid CLI based on mermaid version 11.2.0 which builds the diagram successfully. Not sure what's going on here.

Is there a way to enable verbose / error logging for mermaid when I run the mach doc command? With mach doc --verbose I only see the dependencies being loaded, but no mermaid build errors.

Comment 5

[Sylvestre Ledru [:Sylvestre]]

I think you should report a bug on sphinx-mermaid
Doesn't seem that it is our fault

Comment 6

[Paul Zühlcke [:pbz]]

I'm not sure where the bug is exactly. It could be in our dependency. One would have to setup a sphinx environment and try.
I've at least figured out what is causing the build failure. Our doc system does not seem to like empty classes (without any members). Adding some dummy attributes like here fixes the build error: https://gist.github.com/Trikolon/8845701f398b93b67e0cbf8fd623ad3b#file-gistfile1-txt-L25

Comment 7

[Sylvestre Ledru [:Sylvestre]]

maybe we have some post processing / reformatting removing the tags?!