Skip to content

v0.1.3 — Docs site + auto PyPI publish

Choose a tag to compare

@Mrrobi Mrrobi released this 24 May 23:22
da6fe26

Highlights

  • MkDocs Material documentation site under docs/
    • Index, Quickstart, Architecture, Schemas, CLI, Benchmark, Roadmap
    • Auto-generated API reference via mkdocstrings
    • Deploys to GitHub Pages on every push to main
  • Automated PyPI publishing via GitHub Actions
    • Triggered when a GitHub release is published
    • Uses Trusted Publishing (OIDC) — no PyPI token stored in repo secrets
  • docs extra in pyproject.toml so contributors can run the docs locally with pip install -e .[docs]

Manual steps required on first auto-publish (one-time, repo owner)

  1. PyPI trusted publisher
  2. GitHub Pages source
    • GitHub repo → Settings → Pages → Build and deployment → Source: GitHub Actions

Once those are configured, the next gh release create will auto-build and auto-publish to PyPI; pushes to main that touch docs/ will auto-deploy the site.

Install

pip install narratoflow==0.1.3