Skip to content

Add API docs and PyPI publishing#10

Merged
luisleo526 merged 1 commit into
mainfrom
codex/api-docs-pypi-publishing
Jul 10, 2026
Merged

Add API docs and PyPI publishing#10
luisleo526 merged 1 commit into
mainfrom
codex/api-docs-pypi-publishing

Conversation

@luisleo526

Copy link
Copy Markdown
Contributor

Summary

  • build a searchable MkDocs Material site from the existing guides
  • generate organized Python API references from package signatures, annotations, and docstrings
  • deploy documentation from main through GitHub Pages
  • add exact release-tag verification, wheel/sdist validation, clean-wheel smoke installation, and PyPI Trusted Publishing
  • make README links render correctly on PyPI and expose documentation/release dependency extras

Why

The package now has public models, provider protocols, four built-in providers, backtest runtimes, a streaming bridge, and a FastAPI service. Flat repository Markdown is no longer sufficient for API discovery. The repository also built distributions in CI but had no guarded, credential-free publication path.

User and maintainer impact

Users get searchable guides plus generated API signatures for models, requests, providers, backtesting, streaming, and server components. Maintainers publish by updating project.version and creating a matching v<version> GitHub Release. The protected pypi environment requires approval and only accepts v* tags.

The remaining account-level setup is registering the pending pineforge-data Trusted Publisher on PyPI with owner pineforge-4pass, repository pineforge-data, workflow release.yml, and environment pypi.

Validation

  • ruff check .
  • ruff format --check src tests scripts
  • mypy src
  • pytest — 96 passed, 2 optional Docker tests skipped
  • mkdocs build --strict, including a clean environment with only .[docs]
  • actionlint
  • release-tag positive and negative checks
  • isolated wheel and source-distribution build
  • twine check --strict for both artifacts
  • clean virtual-environment wheel installation and import smoke test

@luisleo526 luisleo526 marked this pull request as ready for review July 10, 2026 17:57
@luisleo526 luisleo526 merged commit b9644ba into main Jul 10, 2026
6 checks passed
@luisleo526 luisleo526 deleted the codex/api-docs-pypi-publishing branch July 10, 2026 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant