haystack-pydoc-tools
Tool to generate Docusaurus-compatible Markdown API references from Python docstrings. It uses griffe to parse source code and griffe2md to render the output.
Installation
pip install haystack-pydoc-tools
Usage
The tool reads YAML configuration files and generates Markdown API docs.
Process a single config file:
haystack-pydoc config.yml [output-directory]
Process a directory of config files (in parallel):
haystack-pydoc pydoc/ output/
A pydoc-markdown alias is also available for backward compatibility.
Output behavior
Each config must specify a filename.
By default, the file is written in the current working directory; if an output directory
is provided, the file is written there instead.
Configuration
Each .yml file describes which modules to document and how to render the output.
Minimal example
loaders:
- search_path: [src]
modules:
- haystack.components.generators.chat.openai
- haystack.components.generators.chat.azure
renderer:
title: Generators
id: generators-api
description: Enables text generation using LLMs.
filename: generators_api.md
Full example
loaders:
- search_path: [../src]
modules:
- haystack.components.generators.chat.openai
- haystack.components.generators.chat.azure
processors:
- type: filter
documented_only: false # include objects without docstrings
skip_empty_modules: false # keep modules even if they have no content
renderer:
title: Generators API
id: generators-api
description: Enables text generation using LLMs.
filename: generators_api.md
When the processors section is omitted, defaults apply: documented_only: true, skip_empty_modules: true.
Legacy example
The tool also accepts the older pydoc-markdown-style configs. Most fields are ignored but don't cause errors.
loaders:
- type: haystack_pydoc_tools.loaders.CustomPythonLoader # ignored
search_path: [../src]
modules:
- haystack.components.generators.chat.openai
- haystack.components.generators.chat.azure
ignore_when_discovered: ["__init__"] # ignored
processors:
- type: filter
expression: # ignored
documented_only: true
do_not_filter_modules: false # ignored
skip_empty_modules: true
- type: smart # ignored
- type: crossref # ignored
renderer:
type: haystack_pydoc_tools.renderers.DocusaurusRenderer # ignored
title: Generators API
id: generators-api
description: Enables text generation using LLMs.
markdown:
descriptive_class_title: false # ignored
classdef_code_block: false # ignored
descriptive_module_title: true # ignored
add_method_class_prefix: true # ignored
add_member_class_prefix: false # ignored
filename: generators_api.md
License
haystack-pydoc-tools is distributed under the terms of the Apache-2.0 license.
Release process
To release version x.y.z:
- Manually update the version in
src/haystack_pydoc_tools/__about__.py(via a PR or a direct push tomain). - From the
mainbranch, create a tag locally:git tag vx.y.z. - Push the tag:
git push --tags. - Wait for the CI to release the package on PyPI.
Metadata
Release files for haystack-pydoc-tools 0.7.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| haystack_pydoc_tools-0.7.0.tar.gz | 26.8 kB | Without provenance | Details for haystack_pydoc_tools-0.7.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| haystack_pydoc_tools-0.7.0-py3-none-any.whl | Python 3 | none | any | Details for haystack_pydoc_tools-0.7.0-py3-none-any.whl |
Total release size: 38.1 kB
Release files / haystack_pydoc_tools-0.7.0.tar.gz
| Download URL | haystack_pydoc_tools-0.7.0.tar.gz |
|---|---|
| Size | 26.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ef23eef95baae3fcbd73ad6e8cf3c0ae757c301437a3a540fde4aa322d9f4e6f
|
|
BLAKE2b-256 checksum How to use checksums |
cf2d1173be4a621a4c1e1bfd87079ec37c29ab25953b7c0e359f682f19c2c45b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.16.3 cpython/3.12.3 HTTPX/0.28.1
|
Release files / haystack_pydoc_tools-0.7.0-py3-none-any.whl
| Download URL | haystack_pydoc_tools-0.7.0-py3-none-any.whl |
|---|---|
| Size | 11.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
96bcc6c304f6657829c54de1def7904764c9afd04b6e3261ff0d8f3b7f09a301
|
|
BLAKE2b-256 checksum How to use checksums |
9fdb12d03aff7ad47286d20c414738fd029829b06e53024f9e9c05356af00ee5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
Hatch/1.16.3 cpython/3.12.3 HTTPX/0.28.1
|
Security for haystack-pydoc-tools 0.7.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.