Consider recommending great-docs for documentation module
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 静か
- 技術スタック
- python
調査の方向性
まず、現在 MkDocs を扱っているドキュメントモジュールのセクションを見つけ、リンク先の great-docs のドキュメントとリポジトリを読んでください。Python 3.11+ の要件と Quarto ベースのワークフローを、コースのセットアップと比較してください。評価に great-docs を推奨または追加すべきかどうかについて文書化された結論が含まれていれば完了です。
索引モデルが issue の本文から書いたものです。
説明
The documentation module currently covers MkDocs. great-docs from Posit is a new Python documentation site generator worth evaluating as an alternative or addition.
Why it's interesting for this course
- Built on Quarto — same toolchain the course already uses for slides
- Zero-config API reference — auto-discovers public API from docstrings (NumPy, Google, Sphinx formats)
- Minimal setup —
great-docs init/build/preview, no templates or manual page authoring needed - Modern defaults — dark mode, responsive, sidebar search, GitHub integration
- AI-ready — generates
llms.txtfiles
Links
- Documentation
- GitHub
- PyPI (requires Python 3.11+)
- 主要言語
- Jupyter Notebook
- スター
- 8
- フォーク
- 1
- 平均マージ
- 4分
- マージ済み PR（30日）
- 1
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
DHI/python-package-development のほかの issue
-
難易度 2/5 1〜2日 初心者へのやさしさ 88/100
-
難易度 2/5 1〜2日 初心者へのやさしさ 72/100
DHI/python-package-development#37 · コメント 1 件 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 48/100
-
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
DHI/python-package-development の issue をすべて見る
似ている issue
-
user-reported
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
Kong/developer.konghq.com#7316 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
HarperFast/skills#96 ·
-
enhancement
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
infinispan/infinispan#18150 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
fullcalendar/fullcalendar#8106 ·