|
Original |
Translation |
|
1
|
|
2
|
You need to have Python 2.4 or higher installed; the toolset used to build the docs is written in Python. It is called *Sphinx*, it is not included in this tree, but maintained separately. Also needed are the docutils, supplying the base markup that Sphinx uses, Jinja, a templating engine, and optionally Pygments, a code highlighter.
|
|
|
3
|
|
|
|
4
|
Luckily, a Makefile has been prepared so that on Unix, provided you have installed Python and Subversion, you can just run ::
|
|
|
5
|
|
|
|
6
|
to check out the necessary toolset in the `tools/` subdirectory and build the HTML output files. To view the generated HTML, point your favorite browser at the top-level index `build/html/index.html` after running "make".
|
|
|
7
|
Available make targets are:
|
|
|
8
|
"html", which builds standalone HTML files for offline viewing.
|
|
|
9
|
"htmlhelp", which builds HTML files and a HTML Help project file usable to convert them into a single Compiled HTML (.chm) file -- these are popular under Microsoft Windows, but very handy on every platform.
|
|
|
10
|
To create the CHM file, you need to run the Microsoft HTML Help Workshop over the generated project (.hhp) file.
|
|