diff options
| author | Tommi Virtanen <tommi.virtanen@dreamhost.com> | 2012-05-03 10:15:21 -0700 |
|---|---|---|
| committer | Tommi Virtanen <tommi.virtanen@dreamhost.com> | 2012-05-03 10:15:21 -0700 |
| commit | 5465e810977d5621f107bf1fea1a4740e11a3290 (patch) | |
| tree | 04da84f6b7b3e4cd5a27b7844e554519c74ecd16 /doc/dev | |
| parent | 93dcc9886fb833e987efd7eaf3bb71d84d79eda9 (diff) | |
| download | ceph-5465e810977d5621f107bf1fea1a4740e11a3290.tar.gz | |
doc: Whitespace cleanup.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
Diffstat (limited to 'doc/dev')
| -rw-r--r-- | doc/dev/documenting.rst | 4 | ||||
| -rw-r--r-- | doc/dev/generatedocs.rst | 24 |
2 files changed, 14 insertions, 14 deletions
diff --git a/doc/dev/documenting.rst b/doc/dev/documenting.rst index f66d7b40ad5..2c67273f973 100644 --- a/doc/dev/documenting.rst +++ b/doc/dev/documenting.rst @@ -98,11 +98,11 @@ Inkscape You can use Inkscape to generate scalable vector graphics. http://inkscape.org for restructedText documents. -If you generate diagrams with Inkscape, you should +If you generate diagrams with Inkscape, you should commit both the Scalable Vector Graphics (SVG) file and export a Portable Network Graphic (PNG) file. Reference the PNG file. By committing the SVG file, others will be able to update the SVG diagrams using Inkscape. -HTML5 will support SVG inline.
\ No newline at end of file +HTML5 will support SVG inline. diff --git a/doc/dev/generatedocs.rst b/doc/dev/generatedocs.rst index f795ec028c2..84f2064820d 100644 --- a/doc/dev/generatedocs.rst +++ b/doc/dev/generatedocs.rst @@ -25,14 +25,14 @@ You must set up SSH keys with github to clone the Ceph repository. If you do not have SSH keys for github, execute: ``$ ssh-keygen -d`` - + Get the key to add to your github account: ``$ cat .ssh/id_dsa.pub`` - + Copy the public key. Then, go to your your github account, click on **Account Settings** (*i.e.*, the tools icon); then, -click **SSH Keys** on the left side navbar. +click **SSH Keys** on the left side navbar. Click **Add SSH key** in the **SSH Keys** list, enter a name for the key, paste the key you generated, and press the **Add key** @@ -41,17 +41,17 @@ button. To clone the Ceph repository, execute: ``$ git clone git@github:ceph/ceph.git`` - + You should have a full copy of the Ceph repository. Install the Required Tools --------------------------- -If you do not have Sphinx and its dependencies installed, +-------------------------- +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: + +To run Sphinx, at least the following are required: - ``python-dev`` - ``python-pip`` @@ -63,10 +63,10 @@ To run Sphinx, at least the following are required: - ``graphviz`` Execute ``apt-get install`` for each dependency that isn't -installed on your host. +installed on your host. ``$ apt-get install python-dev python-pip python-virtualenv libxml2-dev libxslt-dev doxygen ditaa graphviz`` - + Build the Documents @@ -80,6 +80,6 @@ Once you have installed all the dependencies, execute the build: 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.
\ No newline at end of file +in HTML and manpage formats respectively. |