guyzmo/git-repo

Write more thorough documentation

Open

#146 创建于 2017年3月21日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Python (86 fork)batch import
enhancementgood first issuehelp wanted

仓库指标

Star
 (837 star)
PR 合并指标
 (30 天内没有已合并 PR)

描述

  • make a full sphinx documentation for the project with
    • proper manual on how to use it (and why not generate a manpage?)
    • documentation of internals
    • upload of all of it on readthedocs

贡献者指南

研究方向
学习Sphinx文档工具，探索项目结构，开始编写使用说明和内部文档，然后上传到ReadTheDocs。
技术栈
python
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
PythonSphinx
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75