blob: 233ec75c8870cc688abbc6a964fe715894be31fa (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
How to build this documentation from the source
===============================================
Pre-requisites for the simple build, or to update man pages:
* Sphinx 1.0.4 or higher (See http://sphinx.pocoo.org) with “autodoc”
extension installed.
Additional prerequisites to include the API reference based on Doxygen
markup:
* python 2.5 with the Cheetah, lxml, and xml modules
* Doxygen
Simple build without API reference
----------------------------------
To test simple changes to the RST sources, you can build the
documentation without the Doxygen reference by running, from the doc
directory::
sphinx-build rst_source test_html
You will see a number of warnings about missing files. This is
expected.
Updating man pages
------------------
Man pages generated from the RST sources, are checked into the src/man
directory. To regenerate these files, run ``make rstman`` from the
doc subdir of a configured build tree.
As with the simple build, it is normal to see warnings about missing
files when rebuilding the man pages.
Building for a release tarball or web site
------------------------------------------
To generate documentation in HTML format, run ``make rsthtml`` in the
``doc`` subdir of a configured build tree (the build directory
corresponding to ``src/doc``, not the top-level ``doc`` directory).
The output be placed in the top-level ``doc/rst_html`` directory.
This build will include the API reference generated from Doxygen
markup in the source tree.
You can also do this from an unconfigured source tree with::
cd src/doc
make -f Makefile.in top_srcdir=.. PYTHON=python rsthml
make -f Makefile.in clean
|
