Skip to content

Commit db571ac

Browse files
committed
Change Documentation graphics from PNG to SVG format
Changes the generated images from PNG to SVG for size and better rendering on most browsers, and in the generated epub and pdf documents. Signed-off-by: Winford <winford@object.stream>
1 parent b72d7b1 commit db571ac

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

doc/Doxyfile.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2304,7 +2304,7 @@ DIRECTORY_GRAPH = YES
23042304
# The default value is: png.
23052305
# This tag requires that the tag HAVE_DOT is set to YES.
23062306

2307-
DOT_IMAGE_FORMAT = png
2307+
DOT_IMAGE_FORMAT = svg
23082308

23092309
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
23102310
# enable generation of interactive SVG images that allow zooming and panning.

doc/conf.py.in

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ extensions = [
6060
'sphinx.ext.graphviz'
6161
]
6262

63+
6364
suppress_warnings = [
6465
'epub.unknown_project_files',
6566
'misc.highlighting_failure',
@@ -90,6 +91,8 @@ source_suffix = {
9091

9192
# -- Sphinx Extension configuration ---------------------------------------------------
9293

94+
graphviz_output_format = 'svg'
95+
9396
# Breathe configuration
9497
breathe_projects = { "libatomvm": "@CMAKE_CURRENT_BINARY_DIR@/xml/" }
9598
breathe_default_project = "libatomvm"

0 commit comments

Comments
 (0)