[Feature Request] Look into alternative API doc generators
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
Research direction
Start by reviewing the current pydoctor-generated pages on python.temporal.io, especially WorkerDeploymentConfig, and compare alternative pure Python API documentation generators such as pdoc. Evaluate whether each preserves the requested pure API-docs focus and correctly documents dataclass fields including default_versioning_behavior; done means a documented recommendation or migration path.
Written by the indexing model from the issue text.
Description
Describe the solution you'd like
We should consider moving away from https://github.com/twisted/pydoctor for Python API docs. It was originally chosen because of how well it handled @overloads. But it doesn't really get updated much and is a bit buggy, e.g. https://python.temporal.io/temporalio.worker.WorkerDeploymentConfig.html is showing those as class variables (because it doesn't understand data classes) and is even missing default_versioning_behavior that is in source with a default.
Open to all options, but I think we want pure API docs generator, not like Sphinx where English docs come along with, but it's worth a try so long as python.temporal.io is pure API docs. Maybe also try https://pdoc.dev/. Or just check around the ecosystem.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 241
- Avg merge
- 3d 2h
- Merged PRs (30d)
- 49
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from temporalio/sdk-python
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
temporalio/sdk-python#1517 · 10 comments ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
temporalio/sdk-python#496 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
temporalio/sdk-python#1890 ·
-
[Bug] Local activity resolutions regrouped on replay since 1.32.0, delivering the wrong payload Open
Difficulty 4/5 3-5 days Newbie friendliness 52/100
temporalio/sdk-python#1881 · 1 comment ·
-
bug
temporalio/sdk-python#1817 · 1 comment · 1 assignee ·
All issues in temporalio/sdk-python
Similar issues
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
simonw/sqlite-utils#872 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100