diff options
| author | Tom Yu <tlyu@mit.edu> | 2014-02-14 15:59:51 -0500 |
|---|---|---|
| committer | Tom Yu <tlyu@mit.edu> | 2014-02-14 17:42:01 -0500 |
| commit | bfc8f194ae431fc4fadaa431a2a636b4e9b025dd (patch) | |
| tree | d33d371a4ba1c32f1404a28ee3c730c19c3c7229 | |
| parent | b69543edc0afc424a3982cc49176c09d887679cd (diff) | |
| download | krb5-bfc8f194ae431fc4fadaa431a2a636b4e9b025dd.tar.gz krb5-bfc8f194ae431fc4fadaa431a2a636b4e9b025dd.tar.xz krb5-bfc8f194ae431fc4fadaa431a2a636b4e9b025dd.zip | |
Update doc build instructions
Documentation build instructions in doc/README were out of date.
Update them.
ticket: 7864 (new)
tags: pullup
target_version: 1.12.2
| -rw-r--r-- | doc/README | 25 | ||||
| -rw-r--r-- | doc/build_this.rst | 4 |
2 files changed, 7 insertions, 22 deletions
diff --git a/doc/README b/doc/README index a49d11038f..dd26cb0472 100644 --- a/doc/README +++ b/doc/README @@ -1,25 +1,8 @@ -HTML -==== +BUILDING +======== -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 +See doc/build_this.rst for details about how to build the +documentation. CONVENTIONS diff --git a/doc/build_this.rst b/doc/build_this.rst index d31ee232bc..e515df90d4 100644 --- a/doc/build_this.rst +++ b/doc/build_this.rst @@ -23,7 +23,9 @@ directory:: sphinx-build . test_html You will see a number of warnings about missing files. This is -expected. +expected. If there is not already a ``doc/version.py`` file, you will +need to create one by first running ``make version.py`` in the +``src/doc`` directory of a configured build tree. Updating man pages |