Skip to content

Commit d9754ba

Browse files
sadik-smdjeevantelukula
authored andcommitted
conf: include grahviz extension
Include graphviz extension for generating flow diagrams and add graphviz output format as SVG. Include the graphviz package to Dockerfile and rstcheck Signed-off-by: Mahammed Sadik Shaik <s-sadik@ti.com>
1 parent 97b7268 commit d9754ba

3 files changed

Lines changed: 6 additions & 1 deletion

File tree

.rstcheck.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[rstcheck]
2-
ignore_directives = ifconfig,tabs,tab,group-tab,code-tab
2+
ignore_directives = ifconfig,tabs,tab,group-tab,code-tab,graphviz
33
# ignore the following languages because they require external compilers and
44
# snippets in this repo depend on external code
55
ignore_languages = c,cpp,c++

conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
'sphinx.ext.todo',
4040
'sphinx.ext.mathjax',
4141
'sphinx.ext.ifconfig',
42+
'sphinx.ext.graphviz',
4243
'sphinx_rtd_theme',
4344
'sphinx_tabs.tabs',
4445
'sphinx_copybutton'
@@ -253,6 +254,9 @@
253254
# Suppress warnings about excluded documents because every device gets a different toc tree
254255
suppress_warnings = ['toc.excluded']
255256

257+
# Render graphviz diagrams as SVG so that hyperlinks in diagrams are clickable
258+
graphviz_output_format = 'svg'
259+
256260
# -- Tag file loader ------------------------------------------------------
257261

258262
FAMILY = os.environ.get("DEVFAMILY", "")

docker/Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ RUN apk add --no-cache \
88
diffutils \
99
dumb-init \
1010
git \
11+
graphviz \
1112
make \
1213
py3-pip \
1314
ripgrep \

0 commit comments

Comments
 (0)