]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: added demo document changes section 24791/head
authorJames McClune <falcon78921@users.noreply.github.com>
Sun, 28 Oct 2018 05:44:17 +0000 (01:44 -0400)
committerGitHub <noreply@github.com>
Sun, 28 Oct 2018 05:44:17 +0000 (01:44 -0400)
Added a brief section about how to demo Ceph documentation
changes.

Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
doc/dev/generatedocs.rst

index 37c5697bd9cb816844556322556fd01b738562f3..d9d0c0730fca6e342f06d2596a979c62d1232a6c 100644 (file)
@@ -9,6 +9,7 @@ To build the Ceph documentation set, you must:
 1. Clone the Ceph repository
 2. Install the required tools
 3. Build the documents
+4. Demo the documents (Optional)
 
 Clone the Ceph Repository
 -------------------------
@@ -54,3 +55,16 @@ Once you build the documentation set, you may navigate to the source directory t
 
 There should be an ``html`` directory and a ``man`` directory containing documentation
 in HTML and manpage formats respectively.
+
+
+Demo the Documents
+-------------------
+
+Once you build the documentation, as described above, you can demo the rendered documents
+by running ``serve-doc``::
+
+       cd ceph
+       admin/serve-doc
+
+This will serve the ``build-doc/output/html`` directory over port 8080 via 
+Python's ``SimpleHTTPServer`` module.