guyzmo/git-repo

Write more thorough documentation

Open

#146 创建于 2017年3月21日

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

描述

  • 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

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
3-5 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
PythonSphinx
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Set up Sphinx documentation structure in the project, create a proper manual for usage and a manpage, document internals, and configure Read the Docs integration. Refer to similar Python projects' documentation for structure and content.