💻 API文档构建

API documentation building¶

automacdoc¶

Automatically generates API docs from your Python 3 project.

• author: Alexandre Kempf AlexandreKempf
• links: Github | Docs
• installation: pip install git+https://github.com/AlexandreKempf/automacdoc/

mkdocstrings¶

Automatic documentation from sources, for MkDocs.

• Features
• Language agnostic: mkdocstrings is written in Python but is language-agnostic. It means you can use it for any language, as long as you implement a handler for it. Currently, we have a Python handler and a Crystal handler.
• Multiple themes support: each handler can offer multiple themes. Currently, we support the Material theme and offer basic support for the mkdocs and readthedocs themes.
• Cross-references to other objects: mkdocstrings makes it possible to reference other headings from your Markdown files with the classic Markdown syntax: [identifier][] or [title][identifier]. See autorefs.
• Inline injection in Markdown: instead of generating Markdown files, mkdocstrings allows you to inject documentation anywhere in your Markdown contents. The syntax is simple: identifier followed by a 4-spaces indented YAML configuration block.
• ...and more!
• author: Timothée Mazzucotelli pawamoy
• links: Pypi | Github | Docs
• installation: pip install mkdocstrings

MkAutoDoc¶

A Markdown extension which adds autodoc style support, for use with MkDocs.

• author: Tom Christie tomchristie
• links: PyPI GitHub
• installation: pip install mkautodoc

doxygen¶

Allows to generate Doxygen documentation as part of the build process. Doxygen is run (post-build) for each entry in the packages configuration entry (a list of mappings) and the html output moved to a subdirectory of site_dir, with the same name as the entry’s key.

• author: Pieter David pieterdavid
• links: Github | Docs
• installation: pip install git+https://github.com/pieterdavid/mkdocs-doxygen-plugin

dodoc¶

An low-effort attempt to create autodocumentation of class and function definitions/docstrings.

• author: Mark Connelly plasmatech8
• links: Github | Docs
• installation: pip install git+https://github.com/plasmatech8/Python-Mkdocs-Autodoc-Plugin

inari¶

Write docstrings in Markdown.

• author: T.Kameyama tkamenoko
• links: Pypi | Github | Docs
• installation: pip install inari

mktheapidocs¶

Generate markdown API documentation from Numpydoc docstrings.

• author: Jonathan Gray greenape
• links: Pypi | Github | Docs
• installation: pip install mktheapidocs

MkApi¶

Generate API documentation from Markdown docstrings. MkApi supports two styles of docstrings: Google and NumPy.

• Features of MkApi are:

• Section syntax: Supported sections are Args, Arguments, Attributes, Example[s], Note[s], Parameters, Raises, Returns, References, Todo, Warning[s], Warns, and Yields.

• Type annotation: If you write your function such as def func(x: int) -> str:, you don't need write type(s) in Args, Parameters, Returns, or Yields section again. You can overwrite the type annotation in the corresponding docstring.
• Object type inspection: MkApi plugin creates CLASS, DATACLASS, FUNCTION, GENERATOR, or METHOD prefix for each object.
• Attribute inspection: If you write attributes with description as comment in __init__(), Attributes section is automatically created.
• Docstring inheritance: Docstring of a subclass can inherit parameters and attributes description from its superclasses.

• Page mode: Comprehensive API documentation for your project, in which objects are linked to each other by type annotation.

• author: Daizu daizutabi

• links: PyPI | Github | Docs
• installation: pip install mkapi