Yamp

Overview

In the world of project documentation, finding the right tool can be quite challenging. If you've ever tried Sphinx only to find it slow and cumbersome, you may want to explore yamp. This tool, short for Yet Another MkDocs Parser, serves as a bridge between your docstrings and MkDocs, allowing you to create well-organized documentation without the heavy lifting. It’s designed to simplify the documentation process, particularly for Python developers, making it more efficient and user-friendly.

yamp specifically shines when working with projects like River, leveraging its opinionated design to automate linking and maintain clean code documentation. If you're tired of writing repetitive docstrings and prefer to have the tool handle the grunt work, yamp could be your go-to solution.

Features

• Docstring Inheritance: Methods automatically inherit docstrings from their parent classes, reducing redundancy and maintenance.

• Type Annotation Friendly: If you’re using type annotations in your code, yamp eliminates the need to restate parameter types in docstrings.

• Automatic Linking: Mentions of classes and functions are automatically converted into clickable links, enhancing the readability and accessibility of your documentation.

• Pretty Doctests: yamp cleans up doctests by removing unnecessary syntax characters like >>> and ..., leaving you with a polished output.

• Simplified Installation: Compatible with any Python version 3.8 or above, installing yamp provides command-line access with easy operational commands.

• Numpydoc Style Guide Following: yamp encourages adherence to the numpydoc style guide, ensuring consistency in documentation across your project.

• Open Source: As a free tool licensed under the MIT license, developers can contribute and adapt the software according to their needs.