Skip to content

Commit 8bc6be6

Browse files
authored
Add graphviz package to doc build config (cocotb#3457)
Add graphviz package to doc build config, directly use SVG This makes the 'dot' binary available to sphinx.ext.inheritance-diagrams. See also readthedocs/readthedocs.org#8672. Include rendered SVG directly until sphinx-doc/sphinx#10117 is fixed. Closes cocotb#3449
1 parent 2363baf commit 8bc6be6

File tree

3 files changed

+205
-2
lines changed

3 files changed

+205
-2
lines changed

.readthedocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ build:
88
os: ubuntu-22.04
99
tools:
1010
python: "3.11"
11+
apt_packages:
12+
- graphviz
1113

1214
python:
1315
install:
Lines changed: 201 additions & 0 deletions
Loading

documentation/source/library_reference.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,8 +188,8 @@ Logging
188188
Simulation Object Handles
189189
=========================
190190

191-
.. inheritance-diagram:: cocotb.handle
192-
:parts: 1
191+
.. image:: diagrams/svg/inheritance-cocotb.handle.svg
192+
:alt: The class inheritance diagram for cocotb.handle
193193

194194
.. currentmodule:: cocotb.handle
195195

0 commit comments

Comments
 (0)