Use mkdocstrings for documenting Python code
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 30/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- python
- Lĩnh vực
- documentation
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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
- Ngôn ngữ chính
- Python
- Star
- 357
- Fork
- 22
- Merge trung bình
- 10 giờ 31 phút
- Pull request đã merge (30 ngày)
- 2
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của reactive-python/reactpy-django
-
Add coverage tests Đang mởcomplexity: 3 (low) priority: 3 (low) type: ci
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
-
complexity: 1 (high) priority: 1 (high)
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
-
complexity: 2 (medium) priority: 3 (low)
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
-
complexity: 2 (medium) priority: 3 (low)
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
-
`pyscript_router` component Đang mởcomplexity: 1 (high) priority: 2 (moderate)
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 25/100
Tất cả issue của reactive-python/reactpy-django
Issue tương tự
-
link-check link-check:sphinx-theme
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
qgis/QGIS-Documentation#11275 ·
-
bug priority:normal ready-for-dev
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
OpenHands/extensions#626 · 1 bình luận ·
-
Change observation tooltip text Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
CSCfi/sd-search-api#39 ·
-
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100