cppdoc_add_rst_files_dir

Mark a directory with RST files, which belongs to specified target, as once that should take part in HTML documentation generation.

cppdoc_add_rst_files_dir(<target> <rstDocsDirectory>)

This function is intended as a convenience for generating documentation from RST files for a specific target.

Warning

Per current implementation can be called more than once per target. However sequential calls might produce unexpected results.

Arguments

The named <target> must have been created by a command such as add_library and must not be an ALIAS target.

The <rstDocsDirectory> argument must be a valid path to a directory with RST files.

Output

cppdoc_add_rst_files_dir will copy RST files that reside by <rstDocsDirectory> path to following directory:

• <CPPDOC_BINARY_DIR>/src/<target>.