{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation"}],"enrichment":{"capability":"Generates Docusaurus-compatible Markdown API documentation from Python source code by parsing docstrings with griffe and rendering them via griffe2md.","skillfed_tags":["api-documentation","docstring-extraction","docusaurus"],"use_cases":["Auto-generate API reference docs for a Python library and commit them to your Docusaurus site","Batch-process multiple Python packages into separate Markdown files for a unified documentation portal","Migrate from pydoc-markdown to a modern griffe-based workflow while keeping existing YAML configs","Keep API documentation in sync with source code by running the tool in CI on each commit","Generate Markdown API docs for internal tools without manually writing docstring-to-docs converters"],"what_it_does":"haystack-pydoc-tools is a command-line tool that reads YAML configuration files describing Python modules and generates Docusaurus-compatible Markdown API reference documentation. It uses griffe to parse Python source code and extract docstrings, then griffe2md to render them as structured Markdown suitable for documentation sites. The tool supports both single-file and batch processing (with parallel execution) and includes a legacy compatibility mode for older pydoc-markdown configurations.\n\nThe package is designed for teams building documentation sites with Docusaurus who want to keep API docs in sync with source code. Configuration is minimal: you specify search paths, module names, and output metadata (title, description, filename), and the tool handles the rest. It supports filtering (documented-only mode, empty-module skipping) and can be integrated into CI/CD pipelines to regenerate docs on each release.","worth_installing":"Yes. The package solves a real problem\u2014converting Python docstrings to Docusaurus-ready Markdown\u2014with low install friction, active maintenance, no known vulnerabilities, and a permissive license. It's suitable for projects that already use Docusaurus and want automated API doc generation. The YAML-based configuration is straightforward, and parallel processing supports larger codebases. Install if you maintain a Docusaurus site and want to automate API reference generation."},"id":"haystack-pydoc-tools","links":{"html":"https://skillfed.io/packages/haystack-pydoc-tools","md":"https://skillfed.io/packages/haystack-pydoc-tools.md","pypi":"https://pypi.org/project/haystack-pydoc-tools/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2026-02-18","license_spdx":"Apache-2.0","license_treatment":"permissive","name":"haystack-pydoc-tools","python_support":"supports_current","summary":"Pydoc custom tools for Haystack docs"},"popularity":{"monthly_downloads":251167,"position":8593,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.7.0"}