microsoft/vasim

TODO: setup documentation generation

オープン

#5 opened on 2024/08/30

GitHub で見るコントリビューターガイド
 (1 件のコメント) (0 件のリアクション) (0 人の担当者)Python (7 件のフォーク)auto 404
TODOdocumentationhelp wanted

Repository metrics

Stars
 (12 個のスター)
PR merge metrics
 (PR metrics pending)

説明

As we slowly add the documentation, we also should setup auto doc generation. The pipeline code is in place. This particular setup uses sphinx but there are many options we could chose from.

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

調査方針
Sphinx ドキュメント生成を設定します: 'docs' ディレクトリを作成し、conf.py、index.rst を追加し、GitHub Pages または Read the Docs へのデプロイを設定します。
技術スタック
python
領域
developer experience
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
PythonSphinx
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80