Package

class documenteer.stackdocs.pkgdiscovery.Package(root_dir, doc_dir, package_dirs=<factory>, module_dirs=<factory>, static_doc_dirs=<factory>, doxygen_conf_path=None, doxygen_conf_in_path=None)

Bases: object

Metadata about a stack package’s documentation content.

Parameters

• root_dir (Path) –

• doc_dir (Path) –

• package_dirs (Dict[str, Path], default: <factory>) –

• module_dirs (Dict[str, Path], default: <factory>) –

• static_doc_dirs (Dict[str, Path], default: <factory>) –

• doxygen_conf_path (Optional[Path], default: None) –

• doxygen_conf_in_path (Optional[Path], default: None) –

Attributes Summary

doxygen_conf_in_path	Path to the doxygen.conf.in file, indicating Doxygen documentation should be generated.
doxygen_conf_path	Path to the doxygen.conf file, which is typically generated by sconsUtils based on the doxygen.conf.in file, but with additional configurations.

Attributes Documentation

doxygen_conf_in_path: Optional[pathlib.Path] = None

Path to the doxygen.conf.in file, indicating Doxygen documentation should be generated.

doxygen_conf_path: Optional[pathlib.Path] = None

Path to the doxygen.conf file, which is typically generated by sconsUtils based on the doxygen.conf.in file, but with additional configurations.