爲Github項目建立文檔

有兩種編寫方式：

• In reStructuredText
• In Markdown

In reStructuredText 

工具：  pip install sphinx sphinx-autobuild  

克隆你的倉庫到本地：  git clone https://github.com/yourusername/yourrepository.git 

在倉庫根目錄內建立文檔：

mkdir docs  & cd docs


sphinx-quickstart   //按照提示一路下去，會生成index.rst和conf.py，以及一些其餘的目錄和文件

編輯index.rst文件

　　Contents:

　　Indices and tables

　　等

編譯html文件  make html 

 

將本地倉庫上傳到github  git push //輸入帳號密碼 

---

 

註冊並登陸Read the Docs

　　設置 - Connected to Github   //關聯Github帳號

 

開始導入文檔

　　Import a Project  //會自動列出Github上的倉庫名，沒有的話也能夠手動導入

　　按照提示，就能夠成功建立了