Mkgendocs

Overview

mkgendocs is a powerful Python package designed specifically for automating the generation of documentation pages in markdown format from Python source files. By leveraging Google-style docstrings, it efficiently creates clear and organized documentation that is perfect for integration with MkDocs. Unlike other tools that run the code to extract information, mkgendocs takes a unique approach by utilizing Abstract Syntax Trees (AST) to parse source files, making it both fast and reliable.

This package not only simplifies the documentation process but also supports various customization options to ensure that the output meets specific requirements. From handling example directories to generating comprehensive documentation of classes and methods, mkgendocs is an impressive tool for developers looking to streamline their documentation efforts.

Features

• AST Parsing: Extracts information directly from the source files without executing the code, enhancing efficiency and reliability.
• Markdown Output: Generates clean and organized markdown documentation, which easily integrates with MkDocs for a polished presentation.
• Template Support: Allows the use of template markdown files, with placeholders that can be automatically filled with generated documentation, giving flexibility in formatting.
• Automatic Examples Handling: Automatically copies example files and converts their module-level docstrings into markdown, ensuring comprehensive documentation.
• Customizable Configuration: Users can define various parameters, such as directories for sources and templates, repository links, and which classes and functions to document.
• Index Page Creation: Offers the option to generate an index page for easy navigation, enhancing the usability of the documentation.
• Open Source Community Support: Encourages community contributions through a fun suggestion to "buy a coffee," fostering a community-driven development environment.