diff options
| author | Zhanna Tsitkov <tsitkova@mit.edu> | 2011-07-29 19:40:39 +0000 |
|---|---|---|
| committer | Zhanna Tsitkov <tsitkova@mit.edu> | 2011-07-29 19:40:39 +0000 |
| commit | 5adcd3c9956c68edfd90623963585ed9bb39535e (patch) | |
| tree | 86d2990ccee2932ac8cc13c7243995f9e846abf4 /doc/rst_source/README | |
| parent | 496c517956e2071d905cec682c89f8a375552297 (diff) | |
| download | krb5-5adcd3c9956c68edfd90623963585ed9bb39535e.tar.gz krb5-5adcd3c9956c68edfd90623963585ed9bb39535e.tar.xz krb5-5adcd3c9956c68edfd90623963585ed9bb39535e.zip | |
Start building man pages from Sphinx documentation.
Added kinit document to Sphinx docs.
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25062 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'doc/rst_source/README')
| -rw-r--r-- | doc/rst_source/README | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/rst_source/README b/doc/rst_source/README index 63d13461f..1aacbbd2d 100644 --- a/doc/rst_source/README +++ b/doc/rst_source/README @@ -1,3 +1,6 @@ +HTML +==== + To build the documentation as HTML pages run: sphinx-build source_dir destination_dir @@ -8,3 +11,13 @@ 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 + |