agentdocs

agentdoc

tool for maintaining docs for your agents

• GitHub: https://github.com/innivic/agentdoc/
• PyPI package: https://pypi.org/project/agentdoc/
• Created by: innivic | GitHub https://github.com/innivic | PyPI https://pypi.org/user/innivic/
• Free software: MIT License

Features

• TODO

Documentation

Documentation is built with Zensical and deployed to GitHub Pages.

• Live site: https://innivic.github.io/agentdoc/
• Preview locally: just docs-serve (serves at http://localhost:8000)
• Build: just docs-build

API documentation is auto-generated from docstrings using mkdocstrings.

Docs deploy automatically on push to main via GitHub Actions. To enable this, go to your repo's Settings > Pages and set the source to GitHub Actions.

Development

To set up for local development:

# Clone your fork
git clone git@github.com:your_username/agentdoc.git
cd agentdoc

# Install in editable mode with live updates
uv tool install --editable .

This installs the CLI globally but with live updates - any changes you make to the source code are immediately available when you run agentdoc.

Run tests:

uv run pytest

Run quality checks (format, lint, type check, test):

just qa