在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

相关文章

postgresql使用UUID函数的方法

《postgresql使用UUID函数的方法》本文给大家介绍postgresql使用UUID函数的方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录PostgreSQL有两种生成uuid的方法。可以先通过sql查看是否已安装扩展函数,和可以安装的扩展函数

如何使用Lombok进行spring 注入

《如何使用Lombok进行spring注入》本文介绍如何用Lombok简化Spring注入,推荐优先使用setter注入,通过注解自动生成getter/setter及构造器,减少冗余代码,提升开发效... Lombok为了开发环境简化代码,好处不用多说。spring 注入方式为2种,构造器注入和setter

MySQL中比较运算符的具体使用

《MySQL中比较运算符的具体使用》本文介绍了SQL中常用的符号类型和非符号类型运算符,符号类型运算符包括等于(=)、安全等于(=)、不等于(/!=)、大小比较(,=,,=)等,感兴趣的可以了解一下... 目录符号类型运算符1. 等于运算符=2. 安全等于运算符<=>3. 不等于运算符<>或!=4. 小于运

使用zip4j实现Java中的ZIP文件加密压缩的操作方法

《使用zip4j实现Java中的ZIP文件加密压缩的操作方法》本文介绍如何通过Maven集成zip4j1.3.2库创建带密码保护的ZIP文件,涵盖依赖配置、代码示例及加密原理,确保数据安全性,感兴趣的... 目录1. zip4j库介绍和版本1.1 zip4j库概述1.2 zip4j的版本演变1.3 zip4

Python 字典 (Dictionary)使用详解

《Python字典(Dictionary)使用详解》字典是python中最重要,最常用的数据结构之一,它提供了高效的键值对存储和查找能力,:本文主要介绍Python字典(Dictionary)... 目录字典1.基本特性2.创建字典3.访问元素4.修改字典5.删除元素6.字典遍历7.字典的高级特性默认字典

使用Python构建一个高效的日志处理系统

《使用Python构建一个高效的日志处理系统》这篇文章主要为大家详细讲解了如何使用Python开发一个专业的日志分析工具,能够自动化处理、分析和可视化各类日志文件,大幅提升运维效率,需要的可以了解下... 目录环境准备工具功能概述完整代码实现代码深度解析1. 类设计与初始化2. 日志解析核心逻辑3. 文件处

Kotlin Map映射转换问题小结

《KotlinMap映射转换问题小结》文章介绍了Kotlin集合转换的多种方法,包括map(一对一转换)、mapIndexed(带索引)、mapNotNull(过滤null)、mapKeys/map... 目录Kotlin 集合转换:map、mapIndexed、mapNotNull、mapKeys、map

Java docx4j高效处理Word文档的实战指南

《Javadocx4j高效处理Word文档的实战指南》对于需要在Java应用程序中生成、修改或处理Word文档的开发者来说,docx4j是一个强大而专业的选择,下面我们就来看看docx4j的具体使用... 目录引言一、环境准备与基础配置1.1 Maven依赖配置1.2 初始化测试类二、增强版文档操作示例2.

一文详解如何使用Java获取PDF页面信息

《一文详解如何使用Java获取PDF页面信息》了解PDF页面属性是我们在处理文档、内容提取、打印设置或页面重组等任务时不可或缺的一环,下面我们就来看看如何使用Java语言获取这些信息吧... 目录引言一、安装和引入PDF处理库引入依赖二、获取 PDF 页数三、获取页面尺寸(宽高)四、获取页面旋转角度五、判断

Ubuntu 24.04启用root图形登录的操作流程

《Ubuntu24.04启用root图形登录的操作流程》Ubuntu默认禁用root账户的图形与SSH登录,这是为了安全,但在某些场景你可能需要直接用root登录GNOME桌面,本文以Ubuntu2... 目录一、前言二、准备工作三、设置 root 密码四、启用图形界面 root 登录1. 修改 GDM 配