You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/GraphVizSupport.asciidoc
+23-9Lines changed: 23 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,28 +1,42 @@
1
1
:doctitle: GraphViz support
2
+
:sectnums:
3
+
:toc: left
4
+
:toclevels: 4
5
+
6
+
## Introduction
2
7
3
8
link:index[PasDoc] supports the http://www.graphviz.org/[GraphViz] package
4
9
for generating simple unit uses and class inheritance graphs.
5
10
6
11
There are four link:CommandLine[CommandLine] options that can be
7
12
used:
8
13
14
+
## Prerequisite: GraphViz
15
+
16
+
You need to install http://www.graphviz.org/[GraphViz] with the `dot` program.
17
+
18
+
You can install it
19
+
20
+
- from http://www.graphviz.org/[GraphViz website],
21
+
22
+
- or using a package manager for your system, like `sudo apt install graphviz` on Debian/Ubuntu.
23
+
+
24
+
On Windows, you can use https://chocolatey.org/[Chocolatey]. Install https://chocolatey.org/install[Chocolatey itself] first, using _PowerShell_, and then follow https://community.chocolatey.org/packages/Graphviz[installation instructions for `Graphviz` package]. After the installation, `dot` and other GraphViz utilities should be already available on `$PATH` (make sure to close + reopen applications to see new environment variables).
25
+
9
26
## [[options-to-create-graph-files]] Options to create graph files
10
27
11
-
`--graphviz-uses` and `--graphviz-classes` will generate `GVUses.dot` and
12
-
`GVClasses.dot` files that can be used as input for the `dot` program from
13
-
the http://www.graphviz.org/[GraphViz] package like this:
28
+
Command-line options `--graphviz-uses` and `--graphviz-classes` will cause generation of `GVUses.dot` and
29
+
`GVClasses.dot` files that can be used as input for the `dot` program. Follow PasDoc execution by commands like this:
14
30
15
31
----
16
32
dot -T png GVUses.dot > GVUses.png
17
33
dot -T png GVClasses.dot > GVClasses.png
18
34
----
19
35
20
-
This will generate a file GVUses.png containing a graph of unit
21
-
dependencies and GVClasses.png containing a graph of class dependencies.
22
-
23
-
Tip:
36
+
This will generate a file `GVUses.png` containing a graph of unit
37
+
dependencies and `GVClasses.png` containing a graph of class dependencies.
24
38
25
-
The generated graph is usually rather wide which makes it a bit awkward
39
+
_Tip:_The generated graph is usually rather wide which makes it a bit awkward
26
40
to use. By setting the "rankdir" graph attribute to "LR" the graph will
27
41
be built left to right rather than the default top to bottom direction
0 commit comments