Skip to main content

Overview of APIs

PackageSource

Inspired by Sphinx, this tool is designed for generating the Docusaurus documentation project from Python docstrings.

pydocusauruspydocusauruspydocusaurus.__main____main__pydocusaurus->pydocusaurus.__main__pydocusaurus.componentscomponentspydocusaurus->pydocusaurus.componentspydocusaurus.corecorepydocusaurus->pydocusaurus.corepydocusaurus.core.walkerwalkerpydocusaurus->pydocusaurus.core.walkerpydocusaurus.rendererrendererpydocusaurus->pydocusaurus.rendererpydocusaurus.versionversionpydocusaurus->pydocusaurus.versionpydocusaurus.components.apibarapibarpydocusaurus.components->pydocusaurus.components.apibarpydocusaurus.components.comprotocolcomprotocolpydocusaurus.components->pydocusaurus.components.comprotocolpydocusaurus.components.comprotocol->pydocusaurus.components.apibarpydocusaurus.core.analyzeranalyzerpydocusaurus.core->pydocusaurus.core.analyzerpydocusaurus.core.attreeattreepydocusaurus.core->pydocusaurus.core.attreepydocusaurus.core.classesclassespydocusaurus.core->pydocusaurus.core.classespydocusaurus.core.dataclsdataclspydocusaurus.core->pydocusaurus.core.dataclspydocusaurus.core.enumsenumspydocusaurus.core->pydocusaurus.core.enumspydocusaurus.core.functionsfunctionspydocusaurus.core->pydocusaurus.core.functionspydocusaurus.core.inspectorsinspectorspydocusaurus.core->pydocusaurus.core.inspectorspydocusaurus.core.modulesmodulespydocusaurus.core->pydocusaurus.core.modulespydocusaurus.core.opsopspydocusaurus.core->pydocusaurus.core.opspydocusaurus.core.protocolsprotocolspydocusaurus.core->pydocusaurus.core.protocolspydocusaurus.core.textstextspydocusaurus.core->pydocusaurus.core.textspydocusaurus.core.typealiasestypealiasespydocusaurus.core->pydocusaurus.core.typealiasespydocusaurus.core.typeddictstypeddictspydocusaurus.core->pydocusaurus.core.typeddictspydocusaurus.core->pydocusaurus.core.walkerpydocusaurus.core.classes->pydocusaurus.core.functionspydocusaurus.core.classes->pydocusaurus.core.opspydocusaurus.core.classes->pydocusaurus.core.textspydocusaurus.core.datacls->pydocusaurus.core.classespydocusaurus.core.datacls->pydocusaurus.core.functionspydocusaurus.core.datacls->pydocusaurus.core.textspydocusaurus.core.enums->pydocusaurus.core.classespydocusaurus.core.enums->pydocusaurus.core.textspydocusaurus.core.functions->pydocusaurus.core.textspydocusaurus.core.modules->pydocusaurus.core.classespydocusaurus.core.modules->pydocusaurus.core.dataclspydocusaurus.core.modules->pydocusaurus.core.enumspydocusaurus.core.modules->pydocusaurus.core.functionspydocusaurus.core.modules->pydocusaurus.core.inspectorspydocusaurus.core.modules->pydocusaurus.core.protocolspydocusaurus.core.modules->pydocusaurus.core.textspydocusaurus.core.modules->pydocusaurus.core.typealiasespydocusaurus.core.modules->pydocusaurus.core.typeddictspydocusaurus.core.ops->pydocusaurus.core.functionspydocusaurus.core.protocols->pydocusaurus.core.classespydocusaurus.core.typeddicts->pydocusaurus.core.textspydocusaurus.core.walker->pydocusaurus.core.classespydocusaurus.core.walker->pydocusaurus.core.dataclspydocusaurus.core.walker->pydocusaurus.core.enumspydocusaurus.core.walker->pydocusaurus.core.functionspydocusaurus.core.walker->pydocusaurus.core.modulespydocusaurus.core.walker->pydocusaurus.core.protocolspydocusaurus.core.walker->pydocusaurus.core.typealiasespydocusaurus.core.walker->pydocusaurus.core.typeddictspydocusaurus.renderer.componentscomponentspydocusaurus.renderer->pydocusaurus.renderer.componentspydocusaurus.renderer.packagepackagepydocusaurus.renderer->pydocusaurus.renderer.packagepydocusaurus.renderer.pagepagepydocusaurus.renderer->pydocusaurus.renderer.pagepydocusaurus.renderer.resourcesresourcespydocusaurus.renderer->pydocusaurus.renderer.resourcespydocusaurus.renderer.saversaverpydocusaurus.renderer->pydocusaurus.renderer.saverpydocusaurus.renderer.package->pydocusaurus.corepydocusaurus.renderer.page->pydocusaurus.core.classespydocusaurus.renderer.page->pydocusaurus.core.dataclspydocusaurus.renderer.page->pydocusaurus.core.enumspydocusaurus.renderer.page->pydocusaurus.core.functionspydocusaurus.renderer.page->pydocusaurus.core.inspectorspydocusaurus.renderer.page->pydocusaurus.core.modulespydocusaurus.renderer.page->pydocusaurus.core.protocolspydocusaurus.renderer.page->pydocusaurus.core.typealiasespydocusaurus.renderer.page->pydocusaurus.core.typeddictspydocusaurus.renderer.page->pydocusaurus.core.walkerpydocusaurus.renderer.resources->pydocusaurus.renderer.saver

Modules

Member
Description
componentsThe components used for building the documentations.
coreThe core functionalities used to analyze the Python codes and docstrings.
rendererThe centralized renderer used to produce the Markdown format of the documentation.

Aliases

Member
Description
walkerThe inspector and analyzer that walks through and processes the nested package and module members.
render_objRender an arbitrary object as a documentation page.
render_package_as_mdxRender a package as MDX documentation files.