pwr-Solaar/Solaar

Docs: Build developer docs from code

Open

#2,503 opened on 2024年5月27日

GitHub で見る
 (2 comments) (0 reactions) (0 assignees)Python (383 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (4,528 stars)
PR merge metrics
 (平均マージ 1d 15h) (30d で 5 merged PRs)

説明

Some code pieces already contain docstrings, which should be automatically compiled to documentation and published with GitHub pages on a page Developer documentation.

The numpydoc format is the preferred style.

コントリビューターガイド

調査方針
numpydoc形式を使用してドキュメント文字列から自動的にドキュメントを生成し、GitHub Pagesに公開します。
技術スタック
python
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
半日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
PythonGit
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75