diff options
| author | Marti Bolivar <mbolivar@mit.edu> | 2010-10-11 23:47:56 -0400 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@mit.edu> | 2010-10-11 23:47:56 -0400 |
| commit | d8ec48c9312d87d8c358e32550f950fa851c0599 (patch) | |
| tree | c1183cfdccd4595c67858542708e17975d8e7f81 /docs/README | |
| parent | ba02b40212cb1aebd66990f76294c09e35217e93 (diff) | |
| download | librambutan-d8ec48c9312d87d8c358e32550f950fa851c0599.tar.gz librambutan-d8ec48c9312d87d8c358e32550f950fa851c0599.zip | |
switching docs to leaflabs fork of breathe
Diffstat (limited to 'docs/README')
| -rw-r--r-- | docs/README | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/README b/docs/README index b8bf19d..b467d2d 100644 --- a/docs/README +++ b/docs/README @@ -8,11 +8,14 @@ You need a recent-ish version of doxygen in your PATH: http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc For the Doxygen-to-Sphinx bridge, we rely on a project called Breathe, -by Michael Jones. You must clone the breathe repository and set an -environment variable BREATHE_HOME to be able to build the -documentation. Something like this on bash: +by Michael Jones. - $ git clone http://github.com/michaeljones/breathe.git +***** You must clone the LEAFLABS VERSION OF THE breathe repository ****** + + ... and then set an environment variable BREATHE_HOME to be able to +build the documentation. Something like this on bash: + + $ git clone git@github.com:leaflabs/breathe.git $ export BREATHE_HOME=/path/to/breathe/repo/ You can now build the HTML docs with (on Unix): |