diff options
Diffstat (limited to 'src/ceph/doc/dev/generatedocs.rst')
| -rw-r--r-- | src/ceph/doc/dev/generatedocs.rst | 56 |
1 files changed, 0 insertions, 56 deletions
diff --git a/src/ceph/doc/dev/generatedocs.rst b/src/ceph/doc/dev/generatedocs.rst deleted file mode 100644 index 6badef0..0000000 --- a/src/ceph/doc/dev/generatedocs.rst +++ /dev/null @@ -1,56 +0,0 @@ -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/>`_. - -To build the Ceph documentation set, you must: - -1. Clone the Ceph repository -2. Install the required tools -3. Build the documents - -Clone the Ceph Repository -------------------------- - -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. - - -Install the Required Tools --------------------------- - -To build the Ceph documentation, some dependencies are required. -To know what packages are needed, you can launch this command:: - - cd ceph - admin/build-doc - -If dependencies are missing, the command above will fail -with a message that suggests you a command to install all -missing dependencies. - - -Build the Documents -------------------- - -Once you have installed all the dependencies, execute the build (the -same command as above):: - - 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. |