render_package_as_mdx

FunctionSource

render_package_as_mdx(
    package: str | ModuleType,
    out_dir: str | PathLike[str],
    saver: SaverAbstract | None = None,
    package_info: str | PackageInformation | None = None,
)

Render a package as MDX documentation files.

Arguments

Requires

Name	Type	Required	Description
package	str | ModuleType		The name or the module object of a package.
out_dir	str | PathLike[str]		The output directory where the documentation is saved.
saver	SaverAbstract | None		The saver used for dumping the ouput files. It can be overriden if the file saving needs to be customized. If not specified, will use the default saver.
package_info	str | PackageInformation | None		The package information. If str is provided, it will be viewed as the author name. If this value is not specified or partially specified, will attempt to retrive the package information from the parsed results.