diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README | 11 | ||||
| -rw-r--r-- | docs/source/compatibility.rst | 4 | ||||
| -rw-r--r-- | docs/source/errata.rst | 2 |
3 files changed, 8 insertions, 9 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): diff --git a/docs/source/compatibility.rst b/docs/source/compatibility.rst index 6166ec5..8872a1b 100644 --- a/docs/source/compatibility.rst +++ b/docs/source/compatibility.rst @@ -130,7 +130,5 @@ I sorta work And I am also ordinary -Stub. - -(not finished) +Stub (unfinished) diff --git a/docs/source/errata.rst b/docs/source/errata.rst index 09b2ad1..4b03513 100644 --- a/docs/source/errata.rst +++ b/docs/source/errata.rst @@ -14,5 +14,3 @@ list of differences between the Maple and Arduinos, see the page on :local: Stub. - -(not finished) |