From bfc8f194ae431fc4fadaa431a2a636b4e9b025dd Mon Sep 17 00:00:00 2001 From: Tom Yu Date: Fri, 14 Feb 2014 15:59:51 -0500 Subject: 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 --- doc/README | 25 ++++--------------------- 1 file changed, 4 insertions(+), 21 deletions(-) (limited to 'doc/README') diff --git a/doc/README b/doc/README index a49d11038..dd26cb047 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 -- cgit