Building Documentation

Doxyrest contains two documentation packages:

• Build guide

• Manual

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

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

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

Resulting PDF will be placed at: ./build/doxyrest/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/doxyrest/doc/build-guide
./build-html
./build-pdf

Manual

A manual on the Doxyrest command-line tool.

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

Build steps:

cd ./build/doxyrest/doc/manual
./build-html
./build-pdf