doc: added demo document changes section

Added a brief section about how to demo Ceph documentation changes. Signed-off-by: James McClune <[email protected]>
cybozu · Oct 28, 2018 · b8317f5 · b8317f5
1 parent 53e1daf
commit b8317f5
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/doc/dev/generatedocs.rst b/doc/dev/generatedocs.rst
@@ -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.