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

Broken examples of sphinx.ext.inheritance_diagram #10948

Closed
marxin opened this issue Oct 30, 2022 · 3 comments · Fixed by #11040
Closed

Broken examples of sphinx.ext.inheritance_diagram #10948

marxin opened this issue Oct 30, 2022 · 3 comments · Fixed by #11040

Comments

@marxin
Copy link
Contributor

marxin commented Oct 30, 2022

Describe the bug

I think the examples are broken:
https://www.sphinx-doc.org/en/master/usage/extensions/inheritance.html#examples

How to Reproduce

Take a look at the docs.

Environment Information

Linux

Sphinx extensions

No response

Additional context

No response

@jdillard
Copy link
Contributor

jdillard commented Oct 31, 2022

I'm not sure the cause in this case, but I've had a similar symptom before and the cause ended up being the graphing dependency locations changing accidentally and therefore breaking graph generation.

@namurphy
Copy link

We ran into this issue too, over at PlasmaPy/PlasmaPy#1838. It looks like there were some recent releases of graphviz, so I'm wondering if something is happening associated with that.

For reference, the error on https://www.sphinx-doc.org/en/master/usage/extensions/inheritance.html#examples is still happening:

digraph inheritance02ef59160f { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "docutils.parsers.rst.Directive" [URL="../../extdev/markupapi.html#docutils.parsers.rst.Directive",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Base class for reStructuredText directives."]; "sphinx.ext.inheritance_diagram.InheritanceDiagram" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="Run when the inheritance_diagram directive is first encountered."]; "sphinx.util.docutils.SphinxDirective" -> "sphinx.ext.inheritance_diagram.InheritanceDiagram" [arrowsize=0.5,style="setlinewidth(0.5)"]; "sphinx.util.docutils.SphinxDirective" [URL="../../extdev/utils.html#sphinx.util.docutils.SphinxDirective",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="A base class for Sphinx directives."]; "docutils.parsers.rst.Directive" -> "sphinx.util.docutils.SphinxDirective" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

@marxin
Copy link
Contributor Author

marxin commented Dec 20, 2022

As seen here https://readthedocs.org/projects/sphinx/builds/18938758/ I can confirm the issue is caused by missing dot package:

WARNING: dot command 'dot' cannot be run (needed for graphviz output), check the graphviz_dot setting

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

Successfully merging a pull request may close this issue.

3 participants