這幾天看到網(wǎng)上出了個(gè)Cumulus的后繼項(xiàng)目MonaServer, 官網(wǎng)是

http://www.monaserver.ovh/

看介紹相當(dāng)強(qiáng)悍, 包括支持RTMP, RTMFP, RTSP, HTTP, WebSocket等等, 媽呀, 簡(jiǎn)單在流媒體領(lǐng)域大一統(tǒng)了, 所以, 我是有相當(dāng)?shù)呐d趣去業(yè)余研究它的. 我粗略過(guò)了一篇源碼目錄, 然后就想通過(guò)文檔來(lái)進(jìn)一步了解,但是發(fā)現(xiàn)國(guó)外的官網(wǎng)相當(dāng)慢, 沒(méi)有辦法, 就想搞個(gè)本地版本看看. 在源碼目錄doc中, 所有的文檔都是dst格式, 可以通過(guò)sphinx來(lái)生成html, 這樣本地就可以看了.感謝該大牛Thomas Jammet的無(wú)私分享,膜拜一下

另外Cumulus項(xiàng)目的開(kāi)發(fā)者M(jìn)athieu Poux也是MonaSever項(xiàng)目的coauther，下面是我的折騰筆記.

首先需要需要安裝sphinx和bootstrap主題, 它們當(dāng)前版本分別為sphinx 1.3.1和sphinx_bootstrap _theme 0.4.5.

sudo pip install sphinx

sudo pip install sphinx_bootstrap_theme

然后下載源碼

git clone https://github.com/MonaSolutions/MonaServer.git

新建一個(gè)目錄sphinx_mano, 將源碼中的doc目錄復(fù)制過(guò)來(lái)

mkdir? ~/program_develop/python_dev/sphinx_mona

cp -f doc/*? ~/program_develop/python_dev/sphinx_mona

切換到sphinx_mona目錄下面

cd? ~/program_develop/python_dev/sphinx_mona

檢查conf.py, Makefile這些文件是否有異常, 特別注意, 使用sphinx_bootstrap_theme主題時(shí), conf.py中的如下對(duì)應(yīng)配置

import sphinx_bootstrap_theme
html_theme = 'bootstrap'
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()

然后執(zhí)行

make html

如果生成過(guò)程有異常, 就執(zhí)行下面的命令清除

make clean

排除錯(cuò)誤, 然后重新生成就可以了

make html

生成成功之后, 就可以進(jìn)入生成目錄_build/html中使用瀏覽器查看index.html了

說(shuō)明:

這里沒(méi)有使用通常的步驟, 執(zhí)行sphinx-quickstart來(lái)得到一個(gè)目錄框架, 里面做一些配置, 記錄在conf.py中, 同時(shí)還要__build和__static目錄等, 比如

這是因?yàn)镸onaServer的doc目錄下面已經(jīng)存在這些文件和目錄, 并且已經(jīng)配置好了, 不需要我們這么做, 我們只需要將dst文件轉(zhuǎn)換為html觀看就可以了.

后記

這兩天測(cè)試發(fā)現(xiàn)這種讀文檔的方法突然不好使, 研究了一下index.html源碼發(fā)現(xiàn), 里面的css來(lái)自google域名, 萬(wàn)惡的GFW現(xiàn)在越來(lái)越瘋狂了,估計(jì)我前段時(shí)間的翻墻設(shè)置不好使了.無(wú)奈之下, 我只有從MonaServer的官網(wǎng)主頁(yè)看文檔了.

參考文獻(xiàn)

[1].http://www.ibm.com/developerworks/cn/opensource/os-sphinx-documentation/

[2].https://pypi.python.org/pypi/sphinx-bootstrap-theme/

總結(jié)

以上是生活随笔為你收集整理的在Ubuntu 14.04 64bit上使用Sphinx转换MonaServer项目文档的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。