Docs: Replace pdoc3 with Zensical, provide a project + API documentation
Maintainer thường phản hồi trong vòng 3 ngày
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
- 35/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Ít trao đổi
- Công nghệ
- python
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu bằng cách xem xét thiết lập tài liệu pdoc3 hiện có của repository và tài liệu về khả năng tương thích của Zensical được liên kết. Xác định cách cung cấp tài liệu dự án và tài liệu API tự động, sau đó xác minh rằng quá trình di chuyển đã hoàn tất tạo ra cả hai loại tài liệu với điều hướng và thiết kế như dự kiến.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
pdoc3 is pretty limited and not really a state of the art tool for automated API and project documentation anymore.
So far a kind of de-facto standard for modern Python project documentation including automatic API generation has been MKDocs + Material for MKDocs + mkdocstrings for quite some years.
Zensical is the new tool that deprecates MkDocs + Material for MKDocs which will go into maintenance mode as mkdocstrings will. Zensical is developed by the same team as Material for MKDocs and mkdocstrings is and improves design wise limitations of the MKDocs based documentation tech stack.
Zensical almost reached feature parity with Material for MKDocs, supports mkdocsstrings already (until there is added a Zensical-"native" mkdocstrings replacement?) and aims at being backwards compatible.
- Ngôn ngữ chính
- Python
- Star
- 1.2k
- Fork
- 237
- Merge trung bình
- 4 ngày 2 giờ
- Pull request đã merge (30 ngày)
- 9
Chuẩn bị môi trường
Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.
- Có Dockerfile hoặc tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
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 OWASP/pytm
-
Dataflow defaults overwrite values the model set explicitlyCó thể đã có người làm @markthomaschurch đã nhận 1 ngày trước. Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 30/100
Maintainer thường phản hồi trong vòng 3 ngày
-
Calling TM.dfd() a second time returns an empty diagramCó thể làm lại được Pull request cho issue này đã bị đóng mà không được merge. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 25/100
Maintainer thường phản hồi trong vòng 3 ngày
-
Datastore icon is missing from SVG diagrams (absolute PNG path)Có thể đã có người làm @markthomaschurch đã nhận 3 ngày trước. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 20/100
Maintainer thường phản hồi trong vòng 3 ngày
-
Long boundary names render a literal "\n" in the DFDCó thể làm lại được Pull request cho issue này đã bị đóng mà không được merge. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 35/100
Maintainer thường phản hồi trong vòng 3 ngày
-
`TM.check()` overwrites explicit Dataflow `protocol`, `dstPort` and `controls.isEncrypted` with sink defaults (regression in 1.4.0)Có thể đã có người làm @Svastikkka đã nhận 14 ngày trước. Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 75/100
OWASP/pytm#373 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 3 ngày
Issue tương tự
-
15-minutes 5-minutes algorithm any-language beginner-friendly c cpp csharp easy go good first issue hacktoberfest help wanted java javascript kotlin python rust swift typescript
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
Huerte/algo-solutions-python#254 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 86/100
MichaelYcJo/SpecSeal#1543 ·
-
size/s
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 90/100
sipyourdrink-ltd/bernstein#7179 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
good first issue help wanted python up-for-grabs
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
andrewsiah/agentswarm-data-tasks#309 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
bug
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
Maintainer thường phản hồi trong vòng 1 ngày