google/seq2seq

Generate Python API Documentation

オープン

#24 opened on 2017/03/12

GitHub で見るコントリビューターガイド
 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Python (1,329 件のフォーク)batch import
dochelp wanted

Repository metrics

Stars
 (5,587 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

We should generate a proper API documentation based on PyDoc strings. The question are:

  1. How to make it look nice?
  2. How to integrate it into the documentation?

Should finished #23 before doing this.

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

調査方針
Sphinxやpdocなどのツールを使用して、PyDoc文字列からAPIドキュメントを生成する方法を調査してください。ドキュメントの見た目を良くし、既存のプロジェクトドキュメントに統合する方法を決定します。
技術スタック
python
領域
documentation
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
おおむね明確
前提条件
PythonGit
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65