| Commit message (Collapse) | Author | Age | Files | Lines |
|---|
| |
|
|
| |
Signed-off-by: Noah Watkins <noahwatkins@gmail.com>
|
| |
|
|
|
|
|
|
|
|
| |
possible."
This reverts commit c65ffe9f7f27bc0fe5afab36e9ef0de42bc3c74c.
oneiric, where the doc gitbuilder runs, doesn't have the
--system-site-packages option; let's get docs back and sort this out
offline. (virtualenv 1.6.4-0ubuntu1 on oneiric, 1.7.1.2-1 on precise)
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
This avoids the delay of installing Sphinx inside the virtualenv;
especially, compiling lxml is slow.
If Sphinx is not installed system-wide (or it's too old), this will
still install a copy inside the virtualenv, to keep working.
Thanks to Sean for the push to make this happen, and testing the
various scenarios; I (Tv) took the liberty of changing the commit to
use venv-python for the manpage build too, avoid the nonstandard
"which" command, be more careful about quoting, and explain more fully
what's going on in the comment.
Closes: https://github.com/ceph/ceph/pull/24
Signed-off-by: Sean Channel <pentabular@gmail.com>
Signed-off-by: Tommi Virtanen <tv@inktank.com>
|
| |
|
|
| |
Signed-off-by: Dan Mick <dan.mick@inktank.com>
|
| |
|
|
| |
Signed-off-by: Dan Mick <dan.mick@inktank.com>
|
| |
|
|
|
|
|
| |
The docs gitbuilder will use this to avoid rebuilding the virtualenv on
every build.
Signed-off-by: Sage Weil <sage@newdream.net>
|
| | |
|
| |
|
|
|
|
|
|
|
|
| |
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>
|
| |
|
|
|
|
|
|
|
| |
The conditional before running pip install was unnecessary,
"pip install" on already installed packages is fast (as long
as it's not --upgrade), and --quiet makes it not spam the
console.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
|
| |
|
|
|
|
|
|
|
|
|
|
|
| |
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>
|
| |
|
|
| |
Signed-off-by: Samuel Just <samuel.just@dreamhost.com>
|
| |
|
|
| |
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
|
| |
|
|
|
|
|
|
|
|
| |
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>
|
| |
|
|
|
|
|
| |
It requires graphviz / dot to be installed. It generates a nice graph
of the dependencies between classes in the object store.
Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>
|
| |
|
|
| |
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
|
|
|
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>
|
