Use mkdocstrings for documenting Python code
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Review the current manually maintained Python API documentation and the proposed mkdocstrings approach first. Check mkdocstrings/mkdocstrings#450 and #466 to determine whether the blockers are resolved. Done means the docs are generated from Python code, type hints, and docstrings without API-to-documentation mismatches.
Written by the indexing model from the issue text.
Description
Current Situation
Currently, our Python APIs are manually added to the docs, which can potentially result in API <-> Docs mismatch.
Proposed Actions
Use mkdocstrings within the docs to automatically generate markdown based on Python code, type hints, and docstrings.
Implementing this is currently blocked by these issues:
- mkdocstrings/mkdocstrings#450
- mkdocstrings/mkdocstrings#466
- Dominant language
- Python
- Stars
- 357
- Forks
- 22
- Avg merge
- 10h 31m
- Merged PRs (30d)
- 2
Contributor guide
No contributing guide indexed for this repository
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 reactive-python/reactpy-django
-
Add coverage tests Opencomplexity: 3 (low) priority: 3 (low) type: ci
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
complexity: 1 (high) priority: 1 (high)
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
complexity: 2 (medium) priority: 3 (low)
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
complexity: 2 (medium) priority: 3 (low)
Difficulty 5/5 Over a week Newbie friendliness 25/100
-
complexity: 1 (high) priority: 2 (moderate)
Difficulty 5/5 Over a week Newbie friendliness 25/100
All issues in reactive-python/reactpy-django
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
syfoud/Simulated_Scepter#172 ·
-
A cancelled tests run makes the coverage comment workflow fail and reports it as a red check on main Openarea: ci bug perceived difficulty: 3
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Nitjsefnie-Harness-Commons/daedalus#921 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
EleutherAI/lm-evaluation-harness#4207 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ClickHouse/clickhouse-connect#1057 ·