blob: 1aacbbd2d4933a67d2bc4fdfe818e3ee546e553f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
HTML
====
To build the documentation as HTML pages run:
sphinx-build source_dir destination_dir
where
source_dir is the source directory which includes configuration file conf.py and all source files;
destination_dir is the directory for the built documentation.
Once completed, the newly generated HTML documentation can be viewed from the browser by pointing to destination_dir/index.html
MAN PAGES
=========
Similarly, to build the documentation as man pages run:
sphinx-build -b man source_dir destination_dir
The list of manual pages to be built should be constructed under man_pages section on conf.py
|
