Docs: Replace pdoc3 with Zensical, provide a project + API documentation
维护者通常 3 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 文档
- 描述清晰度
- 需要澄清
- 活跃度
- 冷清
- 技术栈
- python
调研方向
首先查看仓库现有的 pdoc3 文档设置以及链接的 Zensical 兼容性文档。确定应如何提供项目文档和自动 API 文档，然后验证完成的迁移能够生成这两种文档，并具有预期的导航和设计。
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- Python
- 星标
- 1.2k
- 派生
- 237
- 平均合并
- 4 天 2 小时
- 30 天内合并 PR
- 9
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
OWASP/pytm 的其他 Issue
-
Dataflow defaults overwrite values the model set explicitly可能已有人在做 @markthomaschurch 于 1 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 30/100
维护者通常 3 天内回复
-
Calling TM.dfd() a second time returns an empty diagram可能重新可做 关联的 PR 已关闭且未合并。 未关闭
难度 2/5 1-3 小时 新手友好度 25/100
维护者通常 3 天内回复
-
Datastore icon is missing from SVG diagrams (absolute PNG path)可能已有人在做 @markthomaschurch 于 3 天前认领。 未关闭
难度 2/5 1-3 小时 新手友好度 20/100
维护者通常 3 天内回复
-
Long boundary names render a literal "\n" in the DFD可能重新可做 关联的 PR 已关闭且未合并。 未关闭
难度 2/5 1-3 小时 新手友好度 35/100
维护者通常 3 天内回复
-
`TM.check()` overwrites explicit Dataflow `protocol`, `dstPort` and `controls.isEncrypted` with sink defaults (regression in 1.4.0)可能已有人在做 @Svastikkka 于 14 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 75/100
维护者通常 3 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
btclib-org/btclib-wallet#872 ·
维护者通常 1 天内回复
-
[Bug]: Scheduled returns scan all accepted minion keys causing extreme load可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭bug needs-triage
难度 2/5 1-3 小时 新手友好度 76/100
saltstack/salt#70789 · 1 条评论 ·
维护者通常 3 天内回复
-
难度 2/5 1-3 小时 新手友好度 87/100
btclib-org/btclib#3093 ·
维护者通常 1 天内回复
-
good first issue
难度 2/5 1-3 小时 新手友好度 85/100
patrickballard/wheelgap#269 ·
-
priority: low python
难度 2/5 1-3 小时 新手友好度 88/100
LearningCircuit/local-deep-research#8635 ·
维护者通常 1 天内回复