Documentation Infrastructure ¶

The documentation of SeqAn has two parts: (1) the API documentation and (2) the manual that you are reading right now.

SeqAn API Documentation ¶

The SeqAn API documentation is created using a customly-written system called dox. You can find out more about the syntax in Dox API Docs.

You can build the documentation in the dox folder:

dox # ./dox_only.sh

The SeqAn manual is created using the Sphinx documentation system. You can build it from the manual folder:

manual # make html

Note that you have to first build the dox documentation since plugins for generating the :dox: links rely on the generated search index for checks.