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.