temporalio / temporalio/sdk-python

[Feature Request] Look into alternative API doc generators

Open
#1,275 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
1.2k
Forks
241
Avg merge
3d 21h
Merged PRs (30d)
55

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.