krb5 commit [krb5-1.12]: Update doc build instructions

Tom Yu tlyu at MIT.EDU
Thu Jun 26 16:36:10 EDT 2014


https://github.com/krb5/krb5/commit/c1377c312c090d554ccb9d273f235b5f9cfbe606
commit c1377c312c090d554ccb9d273f235b5f9cfbe606
Author: Tom Yu <tlyu at mit.edu>
Date:   Fri Feb 14 15:59:51 2014 -0500

    Update doc build instructions
    
    Documentation build instructions in doc/README were out of date.
    Update them.
    
    (cherry picked from commit bfc8f194ae431fc4fadaa431a2a636b4e9b025dd)
    
    ticket: 7864
    version_fixed: 1.12.2
    status: resolved

 doc/README         |   25 ++++---------------------
 doc/build_this.rst |    4 +++-
 2 files changed, 7 insertions(+), 22 deletions(-)

diff --git a/doc/README b/doc/README
index a49d110..dd26cb0 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 d31ee23..e515df9 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


More information about the cvs-krb5 mailing list