google/seq2seq

Generate Python API Documentation

Open

#24 opened on 2017年3月12日

GitHub で見る
 (0 comments) (0 reactions) (0 assignees)Python (1,329 forks)batch import
dochelp wanted

Repository metrics

Stars
 (5,587 stars)
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.

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

調査方針
この課題は、Python ドキュメント文字列から API ドキュメントを生成する必要があります。まず、Sphinx や pydoc のような、見栄えの良いドキュメントを生成できるツールを調査します。生成されたドキュメントを既存のドキュメント構造に統合する方法を決定します。コンテキストを得るために issue #23（最初に完了させるべき）を参照してください。リポジトリの現在のドキュメント設定と既存の設定ファイル（例：docs/conf.py）を確認し、統合ポイントを理解します。
技術スタック
pythontensorflow
領域
documentation
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
ブロック中
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
調査が必要
前提条件
Complete issue #23
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
30