Setting up Documentation

Currently doxygen is being used. At a later point in time we want to re-evaluate standardese. See also the issue on the concepts ts.

Installation

TODO

Configuration

Documentation for users of SeqAn3 shall be generated with these custom settings:

PROJECT_NAME           = "SeqAn3"
INPUT                  = /where/is/seqan3/include
STRIP_FROM_PATH        = /where/is/seqan3/include
STRIP_FROM_INC_PATH    = /where/is/seqan3/include
OUTPUT_DIRECTORY       = /where/should/it/go
RECURSIVE              = YES
DISABLE_INDEX          = YES
GENERATE_TREEVIEW      = YES
INLINE_INHERITED_MEMB  = YES
HAVE_DOT               = YES
COLLABORATION_GRAPH    = NO
TEMPLATE_RELATIONS     = YES
DOT_IMAGE_FORMAT       = svg
INTERACTIVE_SVG        = YES
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
SORT_BRIEF_DOCS        = YES
PREDEFINED             = "CEREAL_SERIALIZE_FUNCTION_NAME=serialize" \
                         "CEREAL_LOAD_FUNCTION_NAME=load" \
                         "CEREAL_SAVE_FUNCTION_NAME=save" \
                         "CEREAL_LOAD_MINIMAL_FUNCTION_NAME=load_minimal" \
                         "CEREAL_SAVE_MINIMAL_FUNCTION_NAME=save_minimal" \
                         "SEQAN3_DOXYGEN_ONLY(x)= x"

For the user documentation add:

EXCLUDE_SYMBOLS        = detail
PREDEFINED             += NDEBUG

For the developer documentation instead add:

ENABLED_SECTIONS       = DEV
EXTRACT_PRIVATE        = YES