update sources to ceph Nautilus 14.2.1

[ceph.git] / ceph / doc / dev / generatedocs.rst

diff --git a/ceph/doc/dev/generatedocs.rst b/ceph/doc/dev/generatedocs.rst
index 6badef0fb6a3eef2b9591b8c84e526e523928809..d9d0c0730fca6e342f06d2596a979c62d1232a6c 100644 (file)
--- a/ceph/doc/dev/generatedocs.rst
+++ b/ceph/doc/dev/generatedocs.rst
@@ -2,13 +2,14 @@ Building Ceph Documentation
 ===========================
 
 Ceph utilizes Python's Sphinx documentation tool. For details on
-the Sphinx documentation tool, refer to `The Sphinx Documentation Tool <http://sphinx.pocoo.org/>`_.
+the Sphinx documentation tool, refer to `The Sphinx Documentation Tool <https://www.sphinx-doc.org/en/master/>`_.
 
 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.