google/seq2seq

Generate Python API Documentation

Open

#24 建立於 2017年3月12日

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

描述

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.

貢獻者指南

技術棧
pythontensorflow
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
blocked
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
needs investigation
前置要求
Complete issue #23
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
30
研究方向
The issue requires generating API documentation from Python docstrings. First, investigate tools like Sphinx or pydoc that can produce nice looking documentation. Determine how to integrate the generated docs into the existing documentation structure. Refer to issue #23 (which should be completed first) for context. Check the repository's current documentation setup and any existing configuration files (e.g., docs/conf.py) to understand the integration points.
Generate Python API Documentation · google/seq2seq#24 | Good First Issue