From: John Wilkins Date: Thu, 8 Nov 2012 06:17:31 +0000 (-0800) Subject: doc: Syntax cleanup for new IA. Removed steps for building docs. X-Git-Tag: v0.55~160 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=e11cafb5788dbe3d5ddf6003f5860ab83058fc7c;p=ceph.git doc: Syntax cleanup for new IA. Removed steps for building docs. Signed-off-by: John Wilkins --- diff --git a/doc/source/building-ceph.rst b/doc/source/building-ceph.rst index e6337f18175..6795c6f2591 100644 --- a/doc/source/building-ceph.rst +++ b/doc/source/building-ceph.rst @@ -1,10 +1,7 @@ =============== Building Ceph =============== -Ceph provides build scripts for source code and for documentation. -Building Ceph -------------- Ceph provides ``automake`` and ``configure`` scripts to streamline the build process. To build Ceph, navigate to your cloned Ceph repository and execute the following:: @@ -27,20 +24,3 @@ If you install Ceph locally, ``make`` will place the executables in ``usr/local/bin``. You may add the ``ceph.conf`` file to the ``usr/local/bin`` directory to run an evaluation environment of Ceph from a single directory. -Building Ceph Documentation ---------------------------- -Ceph utilizes Python’s Sphinx documentation tool. For details on the Sphinx -documentation tool, refer to: `Sphinx`_. To build the Ceph documentaiton, -navigate to the Ceph repository and execute the build script:: - - 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. - -.. _Sphinx: http://sphinx.pocoo.org \ No newline at end of file