-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Initial cut of introduction, getting started, and installing. More to…
… do on installation. RADOS gateway to follow. Signed-off-by: John Wilkins <[email protected]> Signed-off-by: Tommi Virtanen <[email protected]>
- Loading branch information
John Wilkins
authored and
Tommi Virtanen
committed
May 2, 2012
1 parent
d3a2c56
commit a1b31dd
Showing
28 changed files
with
1,772 additions
and
610 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,86 +1,85 @@ | ||
BUILDING CEPH DOCUMENTATION | ||
Building Ceph Documentation | ||
=========================== | ||
|
||
Ceph utilizes Python's "Sphinx" documentation tool. For details on | ||
the Sphinx documentation tool, refer to: http://sphinx.pocoo.org/ | ||
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. Execute admin/build-doc from the ceph directory. | ||
3. Build the documents | ||
|
||
CLONE THE CEPH REPOSITORY | ||
Clone the Ceph Repository | ||
------------------------- | ||
|
||
To clone the Ceph repository, you must have "git" installed | ||
on your local host. To install git, execute: | ||
To clone the Ceph repository, you must have ``git`` installed | ||
on your local host. To install ``git``, execute: | ||
|
||
$ sudo apt-get install git | ||
``$ sudo apt-get install git`` | ||
|
||
You must also have a "github" account. If you do not have a | ||
github account, go to http://github.com and register. | ||
You must also have a github account. If you do not have a | ||
github account, go to `github <http://github.com>`_ and register. | ||
|
||
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 | ||
``$ ssh-keygen -d`` | ||
|
||
Get the key to add to your github account: | ||
|
||
$ cat .ssh/id_dsa.pub | ||
``$ 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 on **Account Settings** (*i.e.*, the tools icon); then, | ||
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" | ||
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** | ||
button. | ||
|
||
To clone the Ceph repository, execute: | ||
|
||
$ git clone git@github:ceph/ceph.git | ||
``$ git clone git@github:ceph/ceph.git`` | ||
|
||
You should have a full copy of the Ceph repository. | ||
|
||
|
||
INSTALL THE REQUIRED TOOLS | ||
-------------------------- | ||
If you think you have the required tools to run Sphinx, | ||
navigate to the Ceph repository and execute the build: | ||
|
||
$ cd ceph | ||
$ admin/build-doc | ||
|
||
Install the Required Tools | ||
-------------------------- | ||
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-dev | ||
python-pip | ||
python-virtualenv | ||
libxml2-dev | ||
libxslt-dev | ||
doxygen | ||
ditaa | ||
graphviz | ||
- ``python-dev`` | ||
- ``python-pip`` | ||
- ``python-virtualenv`` | ||
- ``libxml2-dev`` | ||
- ``libxslt-dev`` | ||
- ``doxygen`` | ||
- ``ditaa`` | ||
- ``graphviz`` | ||
|
||
Execute "apt-get install" for each dependency that isn't | ||
Execute ``apt-get install`` for each dependency that isn't | ||
installed on your host. | ||
|
||
$ apt-get install python-dev python-pip python-virtualenv libxml2-dev libxslt-dev doxygen ditaa graphviz | ||
``$ apt-get install python-dev python-pip python-virtualenv libxml2-dev libxslt-dev doxygen ditaa graphviz`` | ||
|
||
Once you have installed all the dependencies, execute the build again: | ||
|
||
$ cd ceph | ||
$ admin/build-doc | ||
|
||
Build the Documents | ||
------------------- | ||
|
||
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 | ||
``$ cd build-doc/output`` | ||
|
||
There should be an 'html' directory and a 'man' directory containing documentation | ||
There should be an ``html`` directory and a ``man`` directory containing documentation | ||
in HTML and manpage formats respectively. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.