labthings / labthings/python-labthings
RTD documentation
オープン
まだ誰も着手していません。
critical
documentation
in progress
- 主要言語
- Python
- スター
- 19
- フォーク
- 2
- PR マージ指標
- 30日以内にマージされた PR はありません
説明
A lot of stuff can be generated using Sphinx autodocs.
A lot of the documentation around writing Things and Extensions can be taken from the OpenFlexure Microscope docs with little change.
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、プロジェクトの Sphinx ドキュメント設定と、autodocs の対象となっているコードを特定します。Things と Extensions の記述に関する資料を OpenFlexure Microscope のドキュメントで確認し、ここで適用できるものを特定します。python-labthings 用の関連ドキュメントが生成または適応され、正常にビルドできれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- python
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 30/100