Rudder User Documentation is written using the asciidoc formatting language, and includes graphviz schemas. To build the documentation, you need following software:
- Python
-
http://python.org to use asciidoc
- Asciidoc
-
http://www.methods.co.nz/asciidoc/ to build HTML and PDF outputs. To keep control on the asciidoc behaviour after changes in the way asciidoc handles the themes and stylesheets, a copy of asciidoc is distributed with the documentation (issue #2173).
- Docbook
-
http://docbook.org/ to build PDF output. Version 0.3.2-1 or superior.
- Dblatex
-
http://dblatex.sourceforge.net/ to build PDF output.
- Graphviz
-
http://www.graphviz.org/ to build SVG schemas.
- Inkscape
-
http://inkcape.org to convert SVG for PDF output.
- ImageMagick
-
http://www.imagemagick.org/ to normalize the resolution of illustrations.
- Pandoc
-
www.pandoc.org to convert ncf markdown doc to asciidoc
For the tests only:
- Linkchecker
-
http://wummel.github.io/linkchecker/ to check for broken links
apt-get install python docbook dblatex graphviz inkscape imagemagick linkchecker
yum install docbook-utils inkscape ImageMagick linkchecker
To install asciidoc see: http://www.methods.co.nz/asciidoc/INSTALL.html.
To install graphviz see: http://www.graphviz.org/Download.php
To install dblatex see: http://dblatex.sourceforge.net/doc/manual/ch02.html
- XX_title
-
content of the documentation. The list of files to include in the final document is generated at build time from the alphabetically ordered list of text files contained in these directories.
- glossary
-
contains glossary entries. At first occurence of a word, the glossary entry should be included in the text.
- images
-
contains illustrations in PNG format.
- graphviz
-
contains source files for schemas in graphviz format.
- themes
-
contains material for visual formatting of the output.