haystack-pydoc-tools
Pydoc custom tools for Haystack docs
Decision gist · record as of 2026-08-14
Yes. The package solves a real problem—converting Python docstrings to Docusaurus-ready Markdown—with 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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.10 or later; griffe must be able to parse the target Python modules.
- Low friction: pure Python wheel with four straightforward runtime dependencies (black, griffe, griffe2md, pyyaml).
- Active maintenance status with recent releases.
License · maintenance · safety
Apache-2.0 (permissive) — Apache-2.0 permissive license allows commercial and private use with minimal restrictions; suitable for most projects.
last release 2026-02-18 (177 days)
0 known vulnerabilities (OSV.dev, 2026-08-14) · 251,167 downloads/mo, #8,593 on PyPI
Alternatives
Verify before relying
pip install haystack-pydoc-tools
# Create config.yml with loaders and renderer sections
loaders:
- search_path: [src]
modules:
- my_module
renderer:
title: My API
filename: api.md
# Run from command line
haystack-pydoc config.yml output/- Whether the tool handles complex type hints, generics, and modern Python syntax correctly
- Performance characteristics when processing large codebases or many modules in parallel
- Compatibility with different Docusaurus versions and markdown rendering edge cases
What it is and 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.
The 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.
Use it for
- 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
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
The package solves a real problem—converting Python docstrings to Docusaurus-ready Markdown—with 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.
Install
haystack-pydoc-tools on PyPI
Before you install
Low friction: pure Python wheel with four straightforward runtime dependencies (black, griffe, griffe2md, pyyaml). Active maintenance status with recent releases.
Requires Python 3.10 or later; griffe must be able to parse the target Python modules.
License in practice
Apache-2.0 permissive license allows commercial and private use with minimal restrictions; suitable for most projects.
Quickstart
pip install haystack-pydoc-tools
# Create config.yml with loaders and renderer sections
loaders:
- search_path: [src]
modules:
- my_module
renderer:
title: My API
filename: api.md
# Run from command line
haystack-pydoc config.yml output/Verify before relying
- Whether the tool handles complex type hints, generics, and modern Python syntax correctly
- Performance characteristics when processing large codebases or many modules in parallel
- Compatibility with different Docusaurus versions and markdown rendering edge cases
Package facts
| License | Apache-2.0 permissive |
| Python support | Supports the current Python release >=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 4 packagesblackgriffegriffe2mdpyyaml |
| Maintenance | Actively maintained 177 days since the last release |
| First released | |
| Downloads | 251,167 / month, #8,593 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaLicense :: OSI Approved :: Apache Software LicenseProgramming Language :: PythonProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: Implementation :: CPythonProgramming Language :: Python :: Implementation :: PyPy |
Evidence: haystack_pydoc_tools-0.7.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “markdown api documentation generator”
- haystack-pydoc-toolsGenerates Docusaurus-compatible Markdown API documentation from…
- zensicalZensical is a static site generator that converts Markdown…
- pydoc-markdownPydoc-Markdown parses Python source code and generates API…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also pydoc-markdown · griffe2md · mkdocstrings-python · mkdocstrings-python-legacy · pydoctor · griffe-pydantic · docstring-to-markdown · mkdocstrings · pytkdocs · mdformat-toc