1. 程式人生 > >在Github裏集成Readthedocs服務

在Github裏集成Readthedocs服務

遠程同步 ons bho 集成 html .cn 編譯 webhooks down

Readthedocs支持Markdown格式和sphinx格式的文檔排版,是部署項目文檔的絕佳平臺。利用Github的托管服務,我們可以方便地將文檔托管於Github,並利用Readthedocs查閱。

1. 在Readthedocs上新建一個項目,在項目中的:管理 -> Integrations -> 添加Github incoming webhook,記下webhook鏈接地址,待會兒要用;

2. 在Github上新建一個項目,在項目中的:Setting -> Webhooks中添加上面的webhook,用於文檔之間的鏈接;在Setting -> Integrations & Services中添加Services,選擇添加“ReadTheDocs”。

至此,Github與Readthedocs之間的綁定完成,接下來上傳文檔。

3. 在Github項目中新建一個doc文件夾專用於放文檔文件。然後利用python的sphinx庫新建文檔(http://jwch.sdut.edu.cn/book/tool/UseSphinx.html)。

4. 編譯文檔。然後文檔項目中的source文件夾中的所有文件全部傳到Github項目中的doc文件夾中,並遠程同步。Done!

至此,在Readthedocs中就可以查看文檔咯!

在Github裏集成Readthedocs服務