From: Kefu Chai Date: Mon, 8 Oct 2018 10:10:46 +0000 (+0800) Subject: doc: add instructions about using "serve-doc" to preview built document X-Git-Tag: v14.0.1~100^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=feb8cd1267820af9f41067b8e67a15e67eeda385;p=ceph.git doc: add instructions about using "serve-doc" to preview built document Signed-off-by: Kefu Chai --- diff --git a/doc/start/documenting-ceph.rst b/doc/start/documenting-ceph.rst index 56cd8a3eecb3..b83c2288969a 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.