cppdoc_add_pyi_files_dir

Mark a directory with python stub (pyi) files, which belongs to specified target, as once that should take part in HTML documentation generation.

cppdoc_add_pyi_files_dir(<pyModuleName> <target> <pyiStubsDirectory>)

This function is intended as a convenience for generating documentation from python stub files for a specific target. It aims to automate and simplify work with sphinx-apidoc and python stub files.

Warning

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

Warning

Per current implementation this function is available only on Linux systems.

Arguments

The <pyModuleName> argument must be a .

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

The <pyiStubsDirectory> argument must be a valid path to a directory with python stub files.

Requirements

Note

This method requires sphinx.ext.autodoc extension to be enabled in your conf.py.

Output

cppdoc_add_pyi_files_dir will copy python stub files that reside by <pyiStubsDirectory> path to the following directory:

• <CPPDOC_PY_MODULES_BINARY_DIR>/<pyModuleName>.

sphinx-apidoc generated RST files will reside by this the following path:

• ${CPPDOC_BINARY_DIR}/src/<target>