feat: api reference docs pipeline #30
Merged
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
|
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
Signed-off-by: James Ding <jamesding365@gmail.com>
twangodev
force-pushed
the
sdk-v1-docs
branch
from
5583902 to
99b1d40
Compare
…ates Signed-off-by: James Ding <jamesding365@gmail.com>
…emporary) Signed-off-by: James Ding <jamesding365@gmail.com>
Signed-off-by: James Ding <jamesding365@gmail.com>
Signed-off-by: James Ding <jamesding365@gmail.com>
…pository Signed-off-by: James Ding <jamesding365@gmail.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request adds automated documentation generation for the Python SDK using pydoc-markdown. The changes introduce a documentation workflow that generates API reference docs and creates pull requests to a separate docs repository.
Key Changes
- Added pydoc-markdown dependency and configuration for generating API docs
- Created a Python script to copy and transform generated docs with Mintlify frontmatter
- Added a GitHub Actions workflow to automate documentation generation and updates
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| uv.lock | Added dependencies for pydoc-markdown including black, docspec, jinja2, and various utilities |
| scripts/copy_docs.py | New script to copy and transform generated docs to the docs repository with frontmatter |
| pyproject.toml | Added pydoc-markdown dev dependency and configuration for doc generation |
| .github/workflows/docs.yml | New workflow to automate documentation generation and PR creation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
automatically generate docs in https://github.com/fishaudio/docs based off docstrings