Package

class documenteer.stackdocs.pkgdiscovery.Package(root_dir: pathlib.Path, doc_dir: pathlib.Path, package_dirs: Dict[str, pathlib.Path] = <factory>, module_dirs: Dict[str, pathlib.Path] = <factory>, static_doc_dirs: Dict[str, pathlib.Path] = <factory>, doxygen_conf_path: Optional[pathlib.Path] = None, doxygen_conf_in_path: Optional[pathlib.Path] = None)

Bases: object

Metadata about a stack package’s documentation content.

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.