Commit Graph

14 Commits

Author SHA1 Message Date
Ross Turk
53b354dfaa doc: update copyright to include contributors, CC
Signed-off-by: Ross Turk <ross@inktank.com>
2012-10-25 17:51:04 -07:00
Ross Turk
4d7bb07561 doc: update copyright notice in footer
Signed-off-by: Ross Turk <ross@inktank.com>
2012-07-05 15:24:42 -07:00
Ross Turk
cabe74b19e doc: new theme
Signed-off-by: Ross Turk <ross.turk@inktank.com>
2012-05-03 11:03:03 -07:00
John Wilkins
a1b31ddfda Initial cut of introduction, getting started, and installing. More to do on installation. RADOS gateway to follow.
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-02 12:09:54 -07:00
Tommi Virtanen
c960641666 doc: Switch doxygen integration from breathe to asphyxiate.
TODO: path of librados.h is now just the basename

TODO: no enum support for now

TODO: no @bug support for now

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-01-09 19:03:56 -08:00
Tommi Virtanen
200d7c89a6 doc: Switch diagram tools from dia to ditaa.
Now you can create diagrams easily with the ".. ditaa::"
directive in the Sphinx documents.

admin/build-doc now checks for debs required for building
the documentation, or just lists commands missing for hosts
not using dpkg.

For more on Ditaa, see http://ditaa.sourceforge.net/

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-12-06 12:07:59 -08:00
Mark Kampe
4cfe0815cb doc: change state model from .svg to .png
Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
2011-12-01 16:07:41 -08:00
Samuel Just
1c696b6566 doc: Add peering state diagram
Signed-off-by: Samuel Just <samuel.just@dreamhost.com>
2011-11-29 16:35:59 -08:00
Josh Durgin
c00e06f697 doc: add documentation for librbd python bindings
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2011-09-30 11:37:15 -07:00
Tommi Virtanen
66ee58f691 doc: Move internals into a new section, /dev.
Most of the doc is user-oriented, let's isolate internals more.

Split into multiple files. Clean up RST.

Use Sphinx's graphviz plugin for graphs.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-01 13:28:12 -07:00
Tommi Virtanen
df0f32b73a doc: Disable static file copying, we don't use it.
Avoids a warning from sphinx on every run.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-30 12:38:37 -07:00
Tommi Virtanen
c85c2f7535 doc: Adjust how table of contents is presented.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-30 11:26:56 -07:00
Tommi Virtanen
afede55c83 Integrate Doxygen into Sphinx docs.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-29 17:27:14 -07:00
Tommi Virtanen
f1d8964499 First draft of the documentation overhaul.
To build the docs, run ./admin/build-doc. To browse them, either get
them on any static website, or just run ./admin/serve-doc to serve
them quickly off of port 8080.

build-doc sets up a virtualenv to avoid needing Sphinx installed
system-wide. serve-doc needs thttpd installed.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-29 17:27:14 -07:00