URL
https://opencores.org/ocsvn/neorv32/neorv32/trunk
[/] [neorv32/] [trunk/] [docs/] [userguide/] [building_the_documentation.adoc] - Blame information for rev 69
Details |
Compare with Previous |
View Log
| Line No. |
Rev |
Author |
Line |
| 1 |
69 |
zero_gravi |
<<<
|
| 2 |
|
|
:sectnums:
|
| 3 |
|
|
== Building the Documentation
|
| 4 |
|
|
|
| 5 |
|
|
The documentation (datasheet + user guide) is written using `asciidoc`. The according source files
|
| 6 |
|
|
can be found in `docs/...`. The documentation of the software framework is written _in-code_ using `doxygen`.
|
| 7 |
|
|
|
| 8 |
|
|
A makefiles in the project's `docs` directory is provided to build all of the documentation as HTML pages
|
| 9 |
|
|
or as PDF documents.
|
| 10 |
|
|
|
| 11 |
|
|
[TIP]
|
| 12 |
|
|
Pre-rendered PDFs are available online as _nightly pre-releases_: https://github.com/stnolting/neorv32/releases.
|
| 13 |
|
|
The HTML-based documentation is also available online at the project's https://stnolting.github.io/neorv32/[GitHub Pages].
|
| 14 |
|
|
|
| 15 |
|
|
The makefile provides a help target to show all available build options and their according outputs.
|
| 16 |
|
|
|
| 17 |
|
|
[source,bash]
|
| 18 |
|
|
----
|
| 19 |
|
|
neorv32/docs$ make help
|
| 20 |
|
|
----
|
| 21 |
|
|
|
| 22 |
|
|
.Example: Generate HTML documentation (data sheet) using `asciidoctor`
|
| 23 |
|
|
[source,bash]
|
| 24 |
|
|
----
|
| 25 |
|
|
neorv32/docs$ make html
|
| 26 |
|
|
----
|
| 27 |
|
|
|
| 28 |
|
|
[TIP]
|
| 29 |
|
|
If you don't have `asciidoctor` / `asciidoctor-pdf` installed, you can still generate all the documentation using
|
| 30 |
|
|
a _docker container_ via `make container`.
|
© copyright 1999-2024
OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.