package

class sphinx_autoindex.package.Package(name: str, code_path: Path, doc_path: Path, tree_path: str)

Bases: object

__init__(name: str, code_path: Path, doc_path: Path, tree_path: str) → None

Constructor for the Package class

Parameters:

• name – Name of the package

• code_path – Path to the package code

• doc_path – Path to the package documentation

• tree_path – Path to the package tree

build_autodoc_confs(module_name) → str

generate_index() → None

Method to generate the index for the package

generate_modules() → None

Method to generate the modules for the package

scan_package() → None

Method to scan the package for modules and return a list of them