From feb8cd1267820af9f41067b8e67a15e67eeda385 Mon Sep 17 00:00:00 2001 From: Kefu Chai Date: Mon, 8 Oct 2018 18:10:46 +0800 Subject: [PATCH] doc: add instructions about using "serve-doc" to preview built document Signed-off-by: Kefu Chai --- doc/start/documenting-ceph.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/start/documenting-ceph.rst b/doc/start/documenting-ceph.rst index 56cd8a3eecb..b83c2288969 100644 --- a/doc/start/documenting-ceph.rst +++ b/doc/start/documenting-ceph.rst @@ -205,11 +205,12 @@ SHOULD fix warnings that are related to syntax you modified. .. important:: You must validate ALL HYPERLINKS. If a hyperlink is broken, it automatically breaks the build! -Once you build the documentation set, you may navigate to the source directory -to view it:: +Once you build the documentation set, you may start an HTTP server at +``http://localhost:8080/`` to view it:: - cd build-doc/output + admin/serve-doc +You can also navigate to ``build-doc/output`` to inspect the built documents. There should be an ``html`` directory and a ``man`` directory containing documentation in HTML and manpage formats respectively. -- 2.39.5