在Ubuntu 14.04 64bit上使用Sphinx转换MonaServer项目文档

2024-03-18 15:38

本文主要是介绍在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项目文档的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/822817

相关文章

如何使用 Python 读取 Excel 数据

《如何使用Python读取Excel数据》:本文主要介绍使用Python读取Excel数据的详细教程,通过pandas和openpyxl,你可以轻松读取Excel文件,并进行各种数据处理操... 目录使用 python 读取 Excel 数据的详细教程1. 安装必要的依赖2. 读取 Excel 文件3. 读

SpringBoot项目中报错The field screenShot exceeds its maximum permitted size of 1048576 bytes.的问题及解决

《SpringBoot项目中报错ThefieldscreenShotexceedsitsmaximumpermittedsizeof1048576bytes.的问题及解决》这篇文章... 目录项目场景问题描述原因分析解决方案总结项目场景javascript提示:项目相关背景:项目场景:基于Spring

解决Maven项目idea找不到本地仓库jar包问题以及使用mvn install:install-file

《解决Maven项目idea找不到本地仓库jar包问题以及使用mvninstall:install-file》:本文主要介绍解决Maven项目idea找不到本地仓库jar包问题以及使用mvnin... 目录Maven项目idea找不到本地仓库jar包以及使用mvn install:install-file基

Python使用getopt处理命令行参数示例解析(最佳实践)

《Python使用getopt处理命令行参数示例解析(最佳实践)》getopt模块是Python标准库中一个简单但强大的命令行参数处理工具,它特别适合那些需要快速实现基本命令行参数解析的场景,或者需要... 目录为什么需要处理命令行参数?getopt模块基础实际应用示例与其他参数处理方式的比较常见问http

python实现svg图片转换为png和gif

《python实现svg图片转换为png和gif》这篇文章主要为大家详细介绍了python如何实现将svg图片格式转换为png和gif,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录python实现svg图片转换为png和gifpython实现图片格式之间的相互转换延展:基于Py

C 语言中enum枚举的定义和使用小结

《C语言中enum枚举的定义和使用小结》在C语言里,enum(枚举)是一种用户自定义的数据类型,它能够让你创建一组具名的整数常量,下面我会从定义、使用、特性等方面详细介绍enum,感兴趣的朋友一起看... 目录1、引言2、基本定义3、定义枚举变量4、自定义枚举常量的值5、枚举与switch语句结合使用6、枚

使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)

《使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)》PPT是一种高效的信息展示工具,广泛应用于教育、商务和设计等多个领域,PPT文档中常常包含丰富的图片内容,这些图片不仅提升了... 目录一、引言二、环境与工具三、python 提取PPT背景图片3.1 提取幻灯片背景图片3.2 提取

Android实现在线预览office文档的示例详解

《Android实现在线预览office文档的示例详解》在移动端展示在线Office文档(如Word、Excel、PPT)是一项常见需求,这篇文章为大家重点介绍了两种方案的实现方法,希望对大家有一定的... 目录一、项目概述二、相关技术知识三、实现思路3.1 方案一:WebView + Office Onl

springboot项目如何开启https服务

《springboot项目如何开启https服务》:本文主要介绍springboot项目如何开启https服务方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录springboot项目开启https服务1. 生成SSL证书密钥库使用keytool生成自签名证书将

使用Python实现图像LBP特征提取的操作方法

《使用Python实现图像LBP特征提取的操作方法》LBP特征叫做局部二值模式,常用于纹理特征提取,并在纹理分类中具有较强的区分能力,本文给大家介绍了如何使用Python实现图像LBP特征提取的操作方... 目录一、LBP特征介绍二、LBP特征描述三、一些改进版本的LBP1.圆形LBP算子2.旋转不变的LB