tool for maintaining docs for your agents
Project description
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file agentdocs-0.0.1.tar.gz.
File metadata
- Download URL: agentdocs-0.0.1.tar.gz
- Upload date:
- Size: 48.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4389f4b97b94a8414bd52a8c2c23fafb82a668495755ddc9d24094f66b7498b7
|
|
| MD5 |
60f24b128ae2386b0e148ce3c2a5eb7f
|
|
| BLAKE2b-256 |
ac8f9efaaa9e600d381c43868610e998339e1418fb10fef900bb331d1c48f52b
|
File details
Details for the file agentdocs-0.0.1-py3-none-any.whl.
File metadata
- Download URL: agentdocs-0.0.1-py3-none-any.whl
- Upload date:
- Size: 5.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.0 {"installer":{"name":"uv","version":"0.11.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
73ac33048e22b74279285cd81ad0acc1a223c7650a0e092c33c873d7a0363ef0
|
|
| MD5 |
24490ef2743e851184c97ca521b3a1f0
|
|
| BLAKE2b-256 |
87bc024e4af6d61213f0a09582e375c97e8cb92e863afa074d1a2c17be28df28
|
