Skip to content

Commit 4628025

Browse files
committed
Point to Chocolatey from Graphviz page
1 parent 86c64d8 commit 4628025

1 file changed

Lines changed: 23 additions & 9 deletions

File tree

src/GraphVizSupport.asciidoc

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,42 @@
11
:doctitle: GraphViz support
2+
:sectnums:
3+
:toc: left
4+
:toclevels: 4
5+
6+
## Introduction
27

38
link:index[PasDoc] supports the http://www.graphviz.org/[GraphViz] package
49
for generating simple unit uses and class inheritance graphs.
510

611
There are four link:CommandLine[CommandLine] options that can be
712
used:
813

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+
926
## [[options-to-create-graph-files]] Options to create graph files
1027

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:
1430

1531
----
1632
dot -T png GVUses.dot > GVUses.png
1733
dot -T png GVClasses.dot > GVClasses.png
1834
----
1935

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.
2438

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
2640
to use. By setting the "rankdir" graph attribute to "LR" the graph will
2741
be built left to right rather than the default top to bottom direction
2842
resulting in a much more convenient format:
@@ -33,7 +47,7 @@ dot -Grankdir=LR -T png GVUses.dot > GVUses.png
3347

3448
## [[options-to-link-to-graphs-in-documentation]] Options to link to graphs in documentation
3549

36-
--link-gv-uses and --link-gv-classes will add a link to the overview
50+
Command-line options `--link-gv-uses` and `--link-gv-classes` will add a link to the overview
3751
frame pointing to the pictures generated with dot. You must pass the
3852
file extension of the picture (dot can also generate gif and lots of
3953
other formats). So if you generate png you must call

0 commit comments

Comments
 (0)