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.

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

Mermaid sequence diagram does not render in docs website #725

Closed
andy-t-sp opened this issue Feb 28, 2023 · 3 comments
Closed

Mermaid sequence diagram does not render in docs website #725

andy-t-sp opened this issue Feb 28, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@andy-t-sp
Copy link

andy-t-sp commented Feb 28, 2023

Describe the bug

context
When I go to this webpage https://myst-parser.readthedocs.io/en/latest/intro.html#extending-sphinx

expectation
I expected sequence diagram rendering to occur.

bug
But instead the diagram source code is displayed.
Here's what is shown on the screen:
image

problem
This is a problem for people reading the docs because it is meant to showcase what is possible.

Reproduce the bug

  1. Go to: https://myst-parser.readthedocs.io/en/latest/intro.html#extending-sphinx and view the visible code that is there instead of the rendered diagram.

List your environment

Chrome Version 110.0.5481.104 (Official Build) (64-bit) on Windows 10

No response

@andy-t-sp andy-t-sp added the bug Something isn't working label Feb 28, 2023
@welcome
Copy link

welcome bot commented Feb 28, 2023

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@chrisjsewell
Copy link
Member

Hi @andy-t-sp thanks for the feedback, but I'm actually already updating the docs in #717
check it out: https://myst-parser--717.org.readthedocs.build/en/717/index.html

I've actually removed mermaid for now though, due to: mgaitan/sphinxcontrib-mermaid#109
Maybe give them a gentle nudge to fix it 😅

@chrisjsewell chrisjsewell added bug Something isn't working documentation Improvements or additions to documentation and removed bug Something isn't working labels Feb 28, 2023
@andy-t-sp
Copy link
Author

Thanks for the quick reply, @chrisjsewell apologies for reporting something you are already working on, thanks for the link to the bug report in sphinxcontrib-mermaid. I am having a similar issue in my own docs, so thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants