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

Diagrams not appearing correctly in docs #5045

Closed
heidihoward opened this issue Feb 22, 2023 · 4 comments
Closed

Diagrams not appearing correctly in docs #5045

heidihoward opened this issue Feb 22, 2023 · 4 comments

Comments

@heidihoward
Copy link
Member

CCF docs diagrams are not rendering for me today (on edge or chrome). See screenshot below:

image

@eddyashton
Copy link
Member

This is due to an issue with sphinxcontrib-mermaid: mgaitan/sphinxcontrib-mermaid#110

We'll hopefully get a new release and fix shortly, else we could potentially fix this by modifying the mermaid_init_js in conf.py.

@heidihoward
Copy link
Member Author

Seems to working now

@Belmogodx
Copy link

@heidihoward what changed to get them to work any ideas?

@eddyashton
Copy link
Member

@heidihoward what changed to get them to work any ideas?

@Belmogodx - There was a new 0.8.1 release of sphinxcontrib-mermaid, which pinned to an earlier release of mermaid. The CCF docs are built with the latest sphinxcontrib-mermaid, so are now using that pinned version, which references a mermaid.js that's still available on unpkg.com. As discussed in the linked issue, a better fix may be to change the CDN used from unpkg.com to jsdelivr.net, but in either case the diagrams in the CCF docs should now be rendered correctly.

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

No branches or pull requests

3 participants