Building Documentation

AXL contains two documentation packages:

• Build guide
• Library reference & manual

If you have required prerequisites for building documentation, CMake should have created all the necessary shell scripts under: ./build/doc/<doc-package>

sphinx-build is always needed; pdflatex is also needed to build PDF.

Resulting HTML pages will be placed at: ./build/doc/<doc-package>/html

Resulting PDF will be placed at: ./build/doc/<doc-package>/pdf

Build Guide

This is what you are reading right now.

Documentation sources located at: ./doc/build-guide

Build steps:

cd ./build/doc/build-guide
./build-html
./build-pdf

AXL Reference & Manual

Documentation source files are located at: ./doc/manual

doxygen is additionally needed to analyze API headers and extract documentation comments.

doxyrest is also needed to convert Doxygen XML database to reStructured Text (which will be further passed to sphinx-build).

Once doxygen and doxyrest are ready, you can run the scripts (replace Debug with Release if you have built doxyrest under Release configuration).

Build steps:

cd ./build/doc/manual
./build-xml
./build-rst Debug # replace with Release if doxyrest was built for Release
./build-html
./build-pdf