Skip to content

Commit

Permalink
Incorporate suggested wording changes in example
Browse files Browse the repository at this point in the history
  • Loading branch information
j9ac9k committed May 28, 2024
1 parent 683c6d1 commit ebcbbcc
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/examples/graphviz.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Graphviz
Inheritance Diagram
-------------------

Using :mod:`sphinx.ext.inheritance_diagram`, inheritance diagrams can be generated
through :mod:`sphinx.ext.graphviz`. If the output of the inheritance diagrams are
in SVG format, they can be made to conform to light or dark mode.
If you use :mod:`sphinx.ext.inheritance_diagram` to generate inheritance diagrams with
:mod:`sphinx.ext.graphviz`, and you output the inheritance diagrams in SVG format,
they will automatically adapt to this theme's light or dark mode.

To have the inheritance-diagram render to SVG, inside ``conf.py``, you need
the following option.
Expand All @@ -19,7 +19,8 @@ the following option.
graphviz_output_format = 'svg'
...
Below is an example of the inheritance diagram for ``matplotlib.figure.Figure``
Below is an example of the inheritance diagram for ``matplotlib.figure.Figure``.
Try toggling light/dark mode to see it adapt!

.. inheritance-diagram:: matplotlib.figure.Figure

Expand Down

0 comments on commit ebcbbcc

Please sign in to comment.