google/seq2seq

Generate Python API Documentation

开放

#24 创建于 2017年3月12日

在 GitHub 查看贡献者指南
 (0 条评论) (0 个反应) (0 位负责人)Python (1,329 个派生)batch import
dochelp wanted

仓库指标

星标
 (5,587 个星标)
PR 合并指标
 (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