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

doc_dir	Root directory path of the package's doc/ directory.
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.
module_dirs	Module documentation directories.
package_dirs	Package documentation directories.
root_dir	Root directory path of the package.
static_doc_dirs	Sphinx _static/ content directories.

Attributes Documentation

doc_dir: Path = <dataclasses._MISSING_TYPE object>

Root directory path of the package’s doc/ directory.

doxygen_conf_in_path: Optional[Path] = None

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

doxygen_conf_path: Optional[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.

module_dirs: Dict[str, Path] = <dataclasses._MISSING_TYPE object>

Module documentation directories.

Keys are module names (for example, 'lsst.afw.table'). Values are absolute directory paths to the module’s directory inside the package’s doc directory. If a package has no modules the dictionary is empty.

package_dirs: Dict[str, Path] = <dataclasses._MISSING_TYPE object>

Package documentation directories.

Keys are package names (for example, 'afw'). Values are absolute directory paths to the package’s documentation directory inside the package’s doc directory. If there is no package-level documentation the dictionary is empty.

root_dir: Path = <dataclasses._MISSING_TYPE object>

Root directory path of the package.

static_doc_dirs: Dict[str, Path] = <dataclasses._MISSING_TYPE object>

Sphinx _static/ content directories.

Keys are directory names relative to the _static directory. Values are absolute directory paths to the static documentation directory in the package. If there isn’t a declared _static directory, this dictionary is empty.