diff options
| author | Mike Holmes <mike.holmes@linaro.org> | 2016-04-27 17:59:34 -0400 |
|---|---|---|
| committer | Mike Holmes <mike.holmes@linaro.org> | 2016-05-04 14:06:21 -0400 |
| commit | 814086c1e33761fc7d8a3020ffceeb11cb1571e1 (patch) | |
| tree | beef2f140182e9ef02635705679471563aa5418a /CONTRIBUTING | |
| parent | 7c27b1e270678a4b7aa1ab9a791a8aea9366b59a (diff) | |
doc: support asciidoctor
Ascidoctor is a python asciidoc interpreter it has greater capabilities
than asciidoc which is a perl based interpreter.
The resulting style sheet improvements result in more professional
looking docs that can be further enhanced with our own css at some
point.
This also supports including code snippets in the documentation from the
doxygen specification files.
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
Reviewed-by: Bill Fischofer <bill.fischofer@linaro.org>
Diffstat (limited to 'CONTRIBUTING')
| -rw-r--r-- | CONTRIBUTING | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/CONTRIBUTING b/CONTRIBUTING index f6e3fc643..f2f894763 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -106,7 +106,7 @@ Code without a proper signoff cannot be merged into the mainline. 5. Documenting the user docs ---------------------------- -- Users guides are stored in asciidoc format in the odp/docs directory and in +- Users guides are stored in asciidoctor format in the odp/docs directory and in sub directories of it as appropriate. - ODP code references such as types and enums are highlighted using the + syntax. For example text referring to the type odp_pktio_t would decorate the @@ -129,7 +129,7 @@ Code without a proper signoff cannot be merged into the mainline. image::../images/<image name>.svg[align="center"] - The images are stored in the doc/images directory as svg files. - Body text shall wrap at the 80 char point. -- No warnings may be generated by the asciidoc tool. +- No warnings may be generated by the asciidoctor tool. 6. References ------------- |