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

diff --git a/doc/README b/doc/README
index a49d11038fb8338a7f14da416065ba29e08ade41..dd26cb04725dbdd276e5eea242e708da141975ab 100644 (file)
--- 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 d31ee232bcc822573b486fd7efd5fda23b8d69d3..e515df90d4be1b252a90c66f8d3e41691b4cfda8 100644 (file)
--- 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