Repository navigation
docs: add generated Python API reference - #271
Open
mayankbohradev wants to merge 1 commit into
Open
mayankbohradev wants to merge 1 commit into
mayankbohradev wants to merge 1 commit into
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
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
Add an HTML API reference for the public Python SDK. This closes #61.
The reference shows public modules, their docstrings, and their type annotations.
Changes
pdoc==16.0.0todocs/requirements.txt. This keeps pdoc out of the SDK runtime dependencies.scripts/build_api_docs.shto build the reference indocs/api/._audiomodule is absent.master.docs/api/so generated files are not committed.Tests
tox -e py312-latest: 742 tests passed. Tox reported 196 warnings.git diff --check: passed.actionlintwas not available.