Metadata-Version: 2.4
Name: agentdocs
Version: 0.0.1
Summary: tool for maintaining docs for your agents
Project-URL: bugs, https://github.com/innivic/agentdoc/issues
Project-URL: changelog, https://github.com/innivic/agentdoc/releases
Project-URL: documentation, https://innivic.github.io/agentdoc/
Project-URL: homepage, https://github.com/innivic/agentdoc
Author-email: innivic <innivicorg@gmail.com>
Maintainer-email: innivic <innivicorg@gmail.com>
License: MIT
License-File: LICENSE
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: rich
Requires-Dist: typer
Description-Content-Type: text/markdown

# agentdoc

![PyPI version](https://img.shields.io/pypi/v/agentdoc.svg)

tool for maintaining docs for your agents

* GitHub: https://github.com/innivic/agentdoc/
* PyPI package: https://pypi.org/project/agentdoc/
* Created by: **[innivic](innivic.org)** | GitHub https://github.com/innivic | PyPI https://pypi.org/user/innivic/
* Free software: MIT License

## Features

* TODO

## Documentation

Documentation is built with [Zensical](https://zensical.org/) 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](https://mkdocstrings.github.io/).

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:

```bash
# 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:

```bash
uv run pytest
```

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

```bash
just qa
```
