1 Building Ceph Documentation
2 ===========================
4 Ceph utilizes Python's Sphinx documentation tool. For details on
5 the Sphinx documentation tool, refer to `The Sphinx Documentation Tool <http://sphinx.pocoo.org/>`_.
7 To build the Ceph documentation set, you must:
9 1. Clone the Ceph repository
10 2. Install the required tools
11 3. Build the documents
13 Clone the Ceph Repository
14 -------------------------
16 To clone the Ceph repository, you must have ``git`` installed
17 on your local host. To install ``git``, execute::
19 sudo apt-get install git
21 To clone the Ceph repository, execute::
23 git clone git://github.com/ceph/ceph
25 You should have a full copy of the Ceph repository.
28 Install the Required Tools
29 --------------------------
31 To build the Ceph documentation, some dependencies are required.
32 To know what packages are needed, you can launch this command::
37 If dependencies are missing, the command above will fail
38 with a message that suggests you a command to install all
45 Once you have installed all the dependencies, execute the build (the
46 same command as above)::
51 Once you build the documentation set, you may navigate to the source directory to view it::
55 There should be an ``html`` directory and a ``man`` directory containing documentation
56 in HTML and manpage formats respectively.