{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation/2"}],"enrichment":{"capability":"Automatically generates API reference documentation and navigation for Python modules using mkdocstrings, eliminating the need for manual navigation configuration or custom scripts.","skillfed_tags":["mkdocs-plugin","api-documentation","code-generation"],"use_cases":["Generate complete API documentation for a multi-module Python library without manually creating or maintaining nav entries.","Automatically include all submodules in your API docs while excluding private modules and applying consistent docstring formatting.","Integrate API documentation into a larger mkdocs site where the API section can be repositioned or extended with additional pages.","Apply different docstring styles or rendering options to specific modules using regex-based module_options configuration.","Maintain API docs that stay in sync with your codebase structure without manual updates to documentation files or navigation."],"what_it_does":"mkdocs-api-autonav is a plugin for mkdocs that automatically discovers Python modules and generates API reference documentation pages with corresponding navigation entries, using mkdocstrings under the hood. Instead of manually creating documentation files and nav entries for each module and submodule, you point the plugin at your source directories and it handles page generation and navigation structure automatically.\n\nThe plugin integrates with your existing mkdocs.yml nav configuration\u2014it can replace a placeholder entry, append to an existing section, or create a new API Reference section. It supports fine-grained control over which modules to include or exclude, allows per-module docstring rendering options (docstring style, heading levels, etc.), and handles edge cases like implicit namespace packages. It's designed to work well with mkdocs-material's navigation features and plays nicely with mkdocstrings' extensive configuration options.","worth_installing":"Yes. The package is actively maintained, has no known vulnerabilities, low install friction, and solves a real pain point for projects using mkdocs and mkdocstrings. It's particularly valuable if you have multiple modules or frequently add new submodules\u2014it eliminates boilerplate documentation maintenance. The permissive BSD license poses no restrictions."},"id":"mkdocs-api-autonav","links":{"html":"https://skillfed.io/packages/mkdocs-api-autonav","md":"https://skillfed.io/packages/mkdocs-api-autonav.md","pypi":"https://pypi.org/project/mkdocs-api-autonav/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2025-09-09","license_spdx":null,"license_treatment":"permissive","name":"mkdocs-api-autonav","python_support":"supports_current","summary":"Autogenerate API docs with mkdocstrings, including nav"},"popularity":{"monthly_downloads":130700,"position":11630,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.4.0"}