Docs: Replace pdoc3 with Zensical, provide a project + API documentation
メンテナーはふだん 3 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 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時間
- マージ済み PR（30日）
- 9
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン
難易度 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再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン
難易度 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
-
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
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
Huerte/algo-solutions-python#254 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 86/100
MichaelYcJo/SpecSeal#1543 ·
-
size/s
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
sipyourdrink-ltd/bernstein#7179 ·
メンテナーはふだん 1 日以内に返信
-
good first issue help wanted python up-for-grabs
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
andrewsiah/agentswarm-data-tasks#309 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信