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

Replace blockdiag #9134

Closed
Dreamsorcerer opened this issue Sep 12, 2024 · 5 comments · Fixed by #9359
Closed

Replace blockdiag #9134

Dreamsorcerer opened this issue Sep 12, 2024 · 5 comments · Fixed by #9359
Labels
bug documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest We think it's good for https://hacktoberfest.digitalocean.com/

Comments

@Dreamsorcerer
Copy link
Member

In docs/tracing_reference.rst we use blockdiag to create some diagrams. The project is unmaintained now and causing issues upgrading to latest versions of sphinx.

We need someone to replace these diagrams with an alternative. In the Sphinx documentation, they recommend GraphViz: https://chiplicity.readthedocs.io/en/latest/Using_Sphinx/UsingGraphicsAndDiagramsInSphinx.html

So, the blockdiag statements need to be replaced with graphviz ones.

@Dreamsorcerer Dreamsorcerer added bug good first issue Good for newcomers documentation Improvements or additions to documentation Hacktoberfest We think it's good for https://hacktoberfest.digitalocean.com/ labels Sep 12, 2024
@webknjaz
Copy link
Member

I'd look into https://pypi.org/p/sphinx-mermaid

@shirsakm
Copy link

Hi, I would like work on this issue, but I would need some guidance. Would that be okay?

@Dreamsorcerer
Copy link
Member Author

Go ahead. Let us know if you have questions.

@Cycloctane
Copy link
Contributor

Cycloctane commented Sep 30, 2024

Note that sphinx built-in extension sphinx.ext.graphviz requires graphviz executable (dot) to render diagrams. (https://www.sphinx-doc.org/en/master/usage/extensions/graphviz.html#confval-graphviz_dot)
I think if we prefer GraphViz, we may also update contributing.rst to mention this additional requirement in documentation build instructions.

@Dreamsorcerer
Copy link
Member Author

Personally, I don't mind what is used, as long as it works. If someone wants to take it on, use whatever you want.

I'd note that sphinx-mermaid appears to be about as abandoned as blockdiag, so I'm thinking that graphviz is probably a safer bet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation Improvements or additions to documentation good first issue Good for newcomers Hacktoberfest We think it's good for https://hacktoberfest.digitalocean.com/
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants