Documentation

HTML documentation

Currently, building the documentation is only supported on Linux.

Building the documentation requires Doxygen to compile the API reference into XML and man files, moxygen to transpile the XML files into Markdown files, and mdBook to compile the Markdown documentation (which includes the API reference and more) into HTML files. With these three tools installed, run

make docs

to compile the docs, or

make docs-serve

to compile and open the docs in your browser.

man pages

Doxygen can be used alongside doxy2man to compile the API reference into man pages. To do this, simply run

make man
sudo make man-install

This will compile the documentation and install the man pages to the /usr/share/man/man3/ directory.