v0.1.3 — Docs site + auto PyPI publish
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
docsextra inpyproject.tomlso contributors can run the docs locally withpip install -e .[docs]
Manual steps required on first auto-publish (one-time, repo owner)
- PyPI trusted publisher
- Go to https://pypi.org/manage/project/narratoflow/settings/publishing/
- Add a publisher with:
- Owner:
Mrrobi - Repository:
narratoflow - Workflow filename:
release.yml - Environment name:
pypi
- Owner:
- 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