1629893 - Graphviz graphs are not generated, text is displayed instead

Status: RESOLVED FIXED

(Developer Infrastructure :: Source Documentation, defect)

Description

[Francesco Lodolo [:flod]]

See for example this page
https://firefox-source-docs.mozilla.org/build/buildsystem/build-overview.html?highlight=digraph

.. graphviz::

   digraph build_components {
      rankdir="LR";
      "configure" -> "config.status" -> "build backend" -> "build output"
   }

Graph is not generated, the text is simply displayed.

Comment 1

[Sylvestre Ledru [:Sylvestre]]

I didn't know we had graphviz :)
is it something which worked in the past?

FYI, we have mermaid support:
https://firefox-source-docs.mozilla.org/tools/moztreedocs/mermaid-integration.html

Comment 2

[Andrew Halberstadt [:ahal]]

We do have the built-in extension enabled:
https://searchfox.org/mozilla-central/source/docs/conf.py#40

I'm unsure if this was ever working in the past or not.

Comment 3

[Axel Hecht [:Pike]]

So yeah, this probably worked in the past. This requires for graphviz' dot to be installed on the machine, though, https://www.sphinx-doc.org/en/master/usage/extensions/graphviz.html.

This might be on by default on rtd, so it might have been broken for that long :-/

The extension to sphinx is still on in https://searchfox.org/mozilla-central/rev/2cd2d511c0d94a34fb7fa3b746f54170ee759e35/docs/conf.py#40

Comment 4

[Sylvestre Ledru [:Sylvestre]]

I will have a look except if someone wants to try before

Comment 5

[Francesco Lodolo [:flod]]

I've checked quickly, and looks like the build doc is the only currently broken. But we have a patch adding graphs to a couple more docs (that's why I found the error), so it would be great to fix this.

Comment 6

[Axel Hecht [:Pike]]

Attachment: Bug 1629893, add graphviz to lint image to fix docs, r=sylvestre

The sphinx.ext.graphviz extension requires dot to be installed.
That's default on rtd, which is why we use it in the docs.
Adding this to the lint image as we use that for document building,
and it shouldn't hurt.

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/81d4ad686888
add graphviz to lint image to fix docs, r=sylvestre

Comment 8

[Razvan Maries]

https://hg.mozilla.org/mozilla-central/rev/81d4ad686888