在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/
更多相关：
-
这里用散装版本的AutoScssStruct4Vue为例 先去https://github.com/accforgit/AutoScssStruct4Vue下载 然后把解压后的包放入C:UsersAdministrator.vscodeextensions（地址根据你自己的安装目录而定） 点开目录在资源管理器...
-
网上搜到的结果大都不令人满意,这里综合了网上的结构,做了小许改动.希望对大家有帮助. 在Linux下的目录结构操作基本上使用opendir,readdir,closedir就够了. #include
#include #include #include -
文章目录git 最小配置作用域git 创建本地仓库git log 查看版本演进.git 目录refs目录objectsgit 三种对象类型详解 (commit ,tree,blob)...
-
一 . 进入目录权限 如果我在普通用户下创建了一个目录f1，然后使用chomd u-rwx,g-rwx,o-rwx之后，我在普通用户下想进入f1目录，权限不允许。 然后我切换到超级用户下，再次尝试进入到f1目录，这个时候允许进入。 然后回到普通用户下，只给f1的所有者读的权限，然后在普通用户下尝试进入，此时权限还是...
-
windows下rpc框架thrift的环境配置 引用链接: https://www.cnblogs.com/49er/p/7193829.html 最近在弄windows下 的Facebook的rpc 框架 thrift , 网上东西看了很多, 但是大都不能一篇到位, 这里总结了一下, 也记一下自己遇到的问题和解决的方法 这里...
-
爬取妹子网的低级教程连接如下：[爬妹子网](https://blog.csdn.net/baidu_35085676/article/details/68958267) ps：只支持单个套图下载，不支持整体下载 在说说我的这个爬虫代码的设计思路： ①当我们浏览这个网站时，会发现，每一个页面的URL都是以网站的域名+page+页数组成，...
-
if ($g) {$g.$utils || ($g.$utils = {}); } else {var $g = {};$g.$utils = {}; } /*绑定数据神器*/ $g.$utils.bind = {a(html, obj) {return this.object(html, obj);},object(h, o) {f...
-
我们在使用Nginx搭建HTTP的web server的过程中，一般都很顺利，默认的网站根目录一般是/usr/local/nginx/html，我们也可以正常访问到Nginx的欢迎信息，比如使用下面的网址： http://localhost/ 但是发现运行一段时间后，Nginx的error日志中会定期抱怨说，没有找到favicon...
-
菜鸟教程(runoob.com)