google/seq2seq

Generate Python API Documentation

Open

#24 建立於 2017年3月12日

在 GitHub 查看
 (0 留言) (0 反應) (0 負責人)Python (1,329 fork)batch import
dochelp wanted

倉庫指標

Star
 (5,587 star)
PR 合併指標
 (30 天內沒有已合併 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
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 小時
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
新近可參與
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
大致清晰
前置要求
PythonGit
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
65