Docs: Autogeneration of pytm model into docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 229
- PR merge metrics
- No merged PRs in 30d
Description
Continuous Thread Modeling depends on pytm being as simple to use as possible. Would it help to spread the adoption of pytm if we'd auto-generate docs about the pytm model from source code.
A common approach is using mkdocs + mkdocs-material + mkdocstrings[python] which results in something like this.
This would eliminate the risk of manual docs going out of sync from source code (an important part of the pytm docs) and would complement with already existing docs.
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.
Research direction
No files, tests, or entry points are named. Start by reviewing the existing pytm documentation and Python model source, then compare the proposed mkdocs, mkdocs-material, and mkdocstrings[python] setup with the repository's current documentation workflow. Done means generated model documentation complements the existing docs and avoids manual source documentation going out of sync.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100