<<<
:sectnums:
== Building the Documentation

The data sheet and user guide is written using `asciidoc`. The according source files
can be found in `docs`. The documentation of the software framework is written _in-code_ using `doxygen`.
A makefiles in the project's `docs` directory is provided to build all of the documentation as HTML pages
or as PDF documents.

.Pre-Built PDFs
[TIP]
Pre-rendered PDFs are available online as nightly pre-releases: https://github.com/stnolting/neorv32/releases/tag/nightly_release
The HTML-based documentation is also available online at the project's https://stnolting.github.io/neorv32/[GitHub Page].

The makefile provides a help target to show all available build options:

[source,bash]
----
neorv32/docs$ make help
Targets:
 all       - build datasheet and user guide as PDF and HTML
 site      - generate revnumber.txt and build all AsciiDoc documents
 pdf       - build datasheet PDF
 html      - build datasheet HTML
 ug-pdf    - build user guide PDF
 ug-html   - build user guide HTML
 doxygen   - build Doxygen software documentation
 revnumber - generate revnumber.txt from the current Git revision
 clean     - delete generated files and directories
 help      - show this text
----
