Pydoc Markdown
Create Python API documentation in Markdown format.
Overview:
Pydoc-Markdown is a tool to create Python API documentation in Markdown format. It differs from other tools by parsing Python code using docspec instead of executing it. The tool supports multiple documentation styles and offers configuration options for generating documentation.
Features:
- Supports multiple documentation styles: Sphinx, Google, and Pydoc-Markdown specific styles are understood and converted to properly formatted Markdown.
- Docstrings for variables: Can parse docstrings for variables, allowing for better documentation of code.
- Generates links to other API objects: Automatically generates links to other API objects following documentation syntax.
- Configuration options: Can configure the output using a YAML file or pyProject.toml, making it easy to customize documentation generation.
- Integration with Novella: Allows tight integration with static site generators like MkDocs and Hugo, providing additional features and Markdown pre-processing.
Summary:
Pydoc-Markdown is a valuable tool for generating Python API documentation in Markdown format. Its ability to parse docstrings, support multiple documentation styles, and integrate with Novella for advanced features make it a versatile choice for developers looking to document their Python projects efficiently.
- MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
