docs: add Python API reference artifact pipeline - #232
Open
cesarenaldi wants to merge 3 commits into
Open
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
Scope
This intentionally validates representative API shapes before expanding to the complete supported public surface. The generated output covers sync and async clients,
create(),get_balance_allowance(), Pydantic fields, typed dataclasses, enums, type markers, constants, functions, cross-links, and search metadata.The next step is to generate the artifact manually, load it into a Mintlify preview, and evaluate the rendered information architecture before expanding coverage.
Verification
make api-referencemake check(1976 passed,184 deselected)uv buildactionlint .github/workflows/api-reference.yml .github/workflows/release-please.ymluv lock --checkNote
Low Risk
Changes are limited to documentation sources, dev dependencies, and release/CI automation; they do not alter SDK runtime behavior. The release job only writes GitHub Release assets when a normal release is created.
Overview
Adds a Sphinx JSON build that packages a Mintlify-compatible ZIP of the Python SDK reference (clients, sample models/types/values) from installed package docstrings, with warnings treated as build failures via
make api-reference.CI: New manually dispatched
API Referenceworkflow uploads a commit-SHA artifact. The release workflow now exposestag_nameand, after a successful PyPI publish on a new release, builds the same ZIP and attachespolymarket-client-<version>-sphinx.zipto the GitHub Release.Tooling:
docsdependency group (sphinx), lockfile updates, and README/docs underdocs/referencedescribing local builds and Mintlifysdkconfig. Coverage is explicitly a representative POC, not the full public API surface yet.Reviewed by Cursor Bugbot for commit 19ba7be. Bugbot is set up for automated code reviews on this repo. Configure here.