在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/