From b8317f5e1e43c1cd3232701f6a99cbe60f67fb0d Mon Sep 17 00:00:00 2001 From: James McClune Date: Sun, 28 Oct 2018 01:44:17 -0400 Subject: [PATCH] doc: added demo document changes section Added a brief section about how to demo Ceph documentation changes. Signed-off-by: James McClune --- doc/dev/generatedocs.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/dev/generatedocs.rst b/doc/dev/generatedocs.rst index 37c5697bd9c..d9d0c0730fc 100644 --- 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. -- 2.39.5