Ceph utilizes Python's Sphinx documentation tool. For details on the Sphinx documentation tool, refer to The Sphinx Documentation Tool.
To build the Ceph documentation set, you must:
- Clone the Ceph repository
- Install the required tools
- Build the documents
To clone the Ceph repository, you must have git installed
on your local host. To install git, execute:
sudo apt-get install git
To clone the Ceph repository, execute:
git clone git://github.com/ceph/ceph
You should have a full copy of the Ceph repository.
If you do not have Sphinx and its dependencies installed, a list of dependencies will appear in the output. Install the dependencies on your system, and then execute the build.
To run Sphinx, at least the following are required:
python-devpython-pippython-virtualenvlibxml2-devlibxslt-devdoxygenditaagraphviz
Execute apt-get install for each dependency that isn't installed
on your host.:
sudo apt-get install python-dev python-pip python-virtualenv libxml2-dev libxslt-dev doxygen ditaa graphviz ant
Once you have installed all the dependencies, execute the build:
cd ceph admin/build-doc
Once you build the documentation set, you may navigate to the source directory to view it:
cd build-doc/output
There should be an html directory and a man directory containing documentation
in HTML and manpage formats respectively.