在Ubuntu 14.04 64bit上使用Sphinx转换MonaServer项目文档
這幾天看到網上出了個Cumulus的后繼項目MonaServer, 官網是
http://www.monaserver.ovh/
看介紹相當強悍, 包括支持RTMP, RTMFP, RTSP, HTTP, WebSocket等等, 媽呀, 簡單在流媒體領域大一統了, 所以, 我是有相當的興趣去業余研究它的. 我粗略過了一篇源碼目錄, 然后就想通過文檔來進一步了解,但是發現國外的官網相當慢, 沒有辦法, 就想搞個本地版本看看. 在源碼目錄doc中, 所有的文檔都是dst格式, 可以通過sphinx來生成html, 這樣本地就可以看了.感謝該大牛Thomas Jammet的無私分享,膜拜一下
另外Cumulus項目的開發者Mathieu Poux也是MonaSever項目的coauther,下面是我的折騰筆記.
首先需要需要安裝sphinx和bootstrap主題, 它們當前版本分別為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
新建一個目錄sphinx_mano, 將源碼中的doc目錄復制過來
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主題時, conf.py中的如下對應配置
import sphinx_bootstrap_theme
html_theme = 'bootstrap'
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
然后執行
make html
如果生成過程有異常, 就執行下面的命令清除
make clean
排除錯誤, 然后重新生成就可以了
make html
生成成功之后, 就可以進入生成目錄_build/html中使用瀏覽器查看index.html了
說明:
這里沒有使用通常的步驟, 執行sphinx-quickstart來得到一個目錄框架, 里面做一些配置, 記錄在conf.py中, 同時還要__build和__static目錄等, 比如
這是因為MonaServer的doc目錄下面已經存在這些文件和目錄, 并且已經配置好了, 不需要我們這么做, 我們只需要將dst文件轉換為html觀看就可以了.
后記
這兩天測試發現這種讀文檔的方法突然不好使, 研究了一下index.html源碼發現, 里面的css來自google域名, 萬惡的GFW現在越來越瘋狂了,估計我前段時間的翻墻設置不好使了.無奈之下, 我只有從MonaServer的官網主頁看文檔了.
參考文獻
[1].http://www.ibm.com/developerworks/cn/opensource/os-sphinx-documentation/
[2].https://pypi.python.org/pypi/sphinx-bootstrap-theme/
總結
以上是生活随笔為你收集整理的在Ubuntu 14.04 64bit上使用Sphinx转换MonaServer项目文档的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: ATS 5.2.1中Background
- 下一篇: ATS无法缓存QQ音乐的音频文件问题