Skip to content

Commit e0a83ea

Browse files
Add Python API reference generator
1 parent d988a89 commit e0a83ea

8 files changed

Lines changed: 449 additions & 11 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -106,15 +106,11 @@ Custom recorders implement `increment(name, value=1.0, tags=None)` and `record(n
106106

107107
## Documentation
108108

109-
Full documentation is available at [durable-workflow.github.io/docs/2.0/sdks/python/](https://durable-workflow.github.io/docs/2.0/sdks/python/):
109+
Full documentation is available at
110+
[durable-workflow.github.io/docs/2.0/polyglot/python](https://durable-workflow.github.io/docs/2.0/polyglot/python):
110111

111-
- [Quickstart](https://durable-workflow.github.io/docs/2.0/sdks/python/quickstart)
112-
- [Client API](https://durable-workflow.github.io/docs/2.0/sdks/python/client)
113-
- [Workflow Authoring](https://durable-workflow.github.io/docs/2.0/sdks/python/workflows)
114-
- [Activity Authoring](https://durable-workflow.github.io/docs/2.0/sdks/python/activities)
115-
- [Worker Configuration](https://durable-workflow.github.io/docs/2.0/sdks/python/workers)
116-
- [Error Handling](https://durable-workflow.github.io/docs/2.0/sdks/python/errors)
117-
- [Schedules (Cron)](https://durable-workflow.github.io/docs/2.0/sdks/python/schedules)
112+
- [Python SDK guide](https://durable-workflow.github.io/docs/2.0/polyglot/python)
113+
- [API reference](https://durable-workflow.github.io/docs/2.0/polyglot/python-api-reference)
118114

119115
## Requirements
120116

@@ -151,6 +147,10 @@ mypy src/durable_workflow/
151147

152148
# Lint
153149
ruff check src/ tests/
150+
151+
# Regenerate the docs-site API reference
152+
python scripts/generate-api-reference.py \
153+
--output ../durable-workflow.github.io/docs/polyglot/python-api-reference.md
154154
```
155155

156156
## License

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ prometheus = [
4848

4949
[project.urls]
5050
Homepage = "https://github.com/durable-workflow/sdk-python"
51-
Documentation = "https://durable-workflow.github.io/docs/2.0/sdks/python/"
51+
Documentation = "https://durable-workflow.github.io/docs/2.0/polyglot/python"
5252
Repository = "https://github.com/durable-workflow/sdk-python"
5353
Issues = "https://github.com/zorporation/durable-workflow/issues"
5454

0 commit comments

Comments
 (0)