manrajgrover/py-spinners

Documentation: Convert README from markdown to reStructuredText for pypi

Open

#13 建立於 2017年10月24日

在 GitHub 查看
 (1 留言) (0 反應) (0 負責人)Python (17 fork)github user discovery
documentationhacktoberfest

倉庫指標

Star
 (244 star)
PR 合併指標
 (PR 指標待抓取)

描述

Description

Currently, README is in markdown which is not supported by pypi. We need to convert the file to reStructuredText for pypi. This can be automated.

People to notify

None

貢獻者指南

研究方向
將 README.md 檔案轉換為 reStructuredText (.rst) 格式。使用 'pandoc' 等工具自動轉換。然後更新 setup.py 以指向新檔案作為 long description。
技術棧
python
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1 小時以內
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
PythonreStructuredText
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90