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.