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

Documentation graphs are not rendered #725

Closed
abitrolly opened this issue Aug 1, 2022 · 3 comments · Fixed by #751
Closed

Documentation graphs are not rendered #725

abitrolly opened this issue Aug 1, 2022 · 3 comments · Fixed by #751

Comments

@abitrolly
Copy link

https://libcst.readthedocs.io/en/latest/why_libcst.html

Diagrams look like this.

image

@MapleCCC
Copy link
Contributor

I can confirm that I see the same problem on my browser.

By the way, since the last document build is more than 5 months ago, maybe make a fresh document build now is a good idea.

@MapleCCC
Copy link
Contributor

MapleCCC commented Aug 17, 2022

I further investigated the problem. Turn out this bug is related to how the new builder image provided by readthedocs doesn't have the graphviz-dev package pre-installed any more, as elaborated in upstream readthedocs issues 8672 and 8800.

The related readthedocs FAQ entry is seen in "My documentation requires additional dependencies".

The solution, as elaborated on the upstream issues and document, is to set the configuration option build.apt_packages in .readthedocs.yaml to install the graphviz package before document build.

The reason we should choose the graphviz package, instead of other packages whose package names also contain the graphviz keywords, is because it's officially endorsed.

@MapleCCC
Copy link
Contributor

A PR #751 has been opened to fix this issue.

@zsol zsol closed this as completed in #751 Aug 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants