feat: Add API reference documentation with pdoc3 #59
+57
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implements automated API documentation generation: - Added pdoc3 as optional dependency in [project.optional-dependencies] - Created GitHub Actions workflow to build and deploy docs on push to main - Updated README with API reference links and documentation section - Added docs/api/ to .gitignore (generated content) Documentation will be automatically published to GitHub Pages at: https://adcontextprotocol.github.io/adcp-client-python/ Benefits: - Zero-config API reference from existing docstrings - Full type signature visibility - Field descriptions from Pydantic/JSON Schema - Searchable interface - Mobile-friendly HTML 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Regenerated all type files to sync timestamps and ensure imports match. This fixes the CI error where generated.py was trying to import Asset1 which didn't exist in brand_manifest.py. The issue occurred because types were out of sync between generated module files and the consolidated generated.py exports.
Merges type system refactoring and testing improvements from main branch. Changes from main: - Type system refactoring (generated.py → _generated.py) - New stable API layer (src/adcp/types/stable.py) - Testing improvements and documentation - Schema updates (brand manifest, product types) - 138 files changed in merge
bokelley
force-pushed
the
pdoc-api-docs
branch
from
c845a76 to
ac183c6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Implements automated API documentation generation using pdoc3:
https://adcontextprotocol.github.io/adcp-client-python/Test plan
uv run pdoc --html --output-dir docs/api adcpuv run pdoc --http :8080 adcp🤖 Generated with Claude Code