diff options
| author | Greg Hudson <ghudson@mit.edu> | 2012-03-31 06:01:02 +0000 |
|---|---|---|
| committer | Greg Hudson <ghudson@mit.edu> | 2012-03-31 06:01:02 +0000 |
| commit | 3f19f78897bcc370261cae11fb7ac18378e3055c (patch) | |
| tree | 2b5e7824c9a322298f38774e6e92d4afac6bf6f9 /doc | |
| parent | c49954a13ec5ebfecc20b25f68649983522adb03 (diff) | |
| download | krb5-3f19f78897bcc370261cae11fb7ac18378e3055c.tar.gz krb5-3f19f78897bcc370261cae11fb7ac18378e3055c.tar.xz krb5-3f19f78897bcc370261cae11fb7ac18378e3055c.zip | |
Edit RST docs on building RST docs
Fix a couple of grammar errors noted by Ben Kaduk, and elaborate a
little bit on why generated man pages are checked into the repository.
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25798 dc483132-0cff-0310-8789-dd5450dbe970
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rst_source/relay/build_this.rst | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/rst_source/relay/build_this.rst b/doc/rst_source/relay/build_this.rst index d91a6d55d..f51d1047d 100644 --- a/doc/rst_source/relay/build_this.rst +++ b/doc/rst_source/relay/build_this.rst @@ -29,10 +29,12 @@ 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 -man subdirectory of a configured build tree. You can also do this -from an unconfigured source tree with:: +Man pages are generated from the RST sources and checked into the +``src/man`` directory of the repository. This allows man pages to be +installed without requiring Sphinx when using a source checkout. To +regenerate these files, run ``make rstman`` from the man subdirectory +of a configured build tree. You can also do this from an unconfigured +source tree with:: cd src/man make -f Makefile.in top_srcdir=.. srcdir=. rstman @@ -48,7 +50,7 @@ Building for a release tarball or web site To generate documentation in HTML format, run ``make rsthtml`` in the ``doc`` subdirectory 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. +The output will 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. |