在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

相关文章

Android kotlin中 Channel 和 Flow 的区别和选择使用场景分析

《Androidkotlin中Channel和Flow的区别和选择使用场景分析》Kotlin协程中,Flow是冷数据流,按需触发,适合响应式数据处理;Channel是热数据流,持续发送,支持... 目录一、基本概念界定FlowChannel二、核心特性对比数据生产触发条件生产与消费的关系背压处理机制生命周期

java使用protobuf-maven-plugin的插件编译proto文件详解

《java使用protobuf-maven-plugin的插件编译proto文件详解》:本文主要介绍java使用protobuf-maven-plugin的插件编译proto文件,具有很好的参考价... 目录protobuf文件作为数据传输和存储的协议主要介绍在Java使用maven编译proto文件的插件

如何在Ubuntu 24.04上部署Zabbix 7.0对服务器进行监控

《如何在Ubuntu24.04上部署Zabbix7.0对服务器进行监控》在Ubuntu24.04上部署Zabbix7.0监控阿里云ECS服务器,需配置MariaDB数据库、开放10050/1005... 目录软硬件信息部署步骤步骤 1:安装并配置mariadb步骤 2:安装Zabbix 7.0 Server

SpringBoot线程池配置使用示例详解

《SpringBoot线程池配置使用示例详解》SpringBoot集成@Async注解,支持线程池参数配置(核心数、队列容量、拒绝策略等)及生命周期管理,结合监控与任务装饰器,提升异步处理效率与系统... 目录一、核心特性二、添加依赖三、参数详解四、配置线程池五、应用实践代码说明拒绝策略(Rejected

C++ Log4cpp跨平台日志库的使用小结

《C++Log4cpp跨平台日志库的使用小结》Log4cpp是c++类库,本文详细介绍了C++日志库log4cpp的使用方法,及设置日志输出格式和优先级,具有一定的参考价值,感兴趣的可以了解一下... 目录一、介绍1. log4cpp的日志方式2.设置日志输出的格式3. 设置日志的输出优先级二、Window

Ubuntu如何分配​​未使用的空间

《Ubuntu如何分配​​未使用的空间》Ubuntu磁盘空间不足,实际未分配空间8.2G因LVM卷组名称格式差异(双破折号误写)导致无法扩展,确认正确卷组名后,使用lvextend和resize2fs... 目录1:原因2:操作3:报错5:解决问题:确认卷组名称​6:再次操作7:验证扩展是否成功8:问题已解

Qt使用QSqlDatabase连接MySQL实现增删改查功能

《Qt使用QSqlDatabase连接MySQL实现增删改查功能》这篇文章主要为大家详细介绍了Qt如何使用QSqlDatabase连接MySQL实现增删改查功能,文中的示例代码讲解详细,感兴趣的小伙伴... 目录一、创建数据表二、连接mysql数据库三、封装成一个完整的轻量级 ORM 风格类3.1 表结构

使用Docker构建Python Flask程序的详细教程

《使用Docker构建PythonFlask程序的详细教程》在当今的软件开发领域,容器化技术正变得越来越流行,而Docker无疑是其中的佼佼者,本文我们就来聊聊如何使用Docker构建一个简单的Py... 目录引言一、准备工作二、创建 Flask 应用程序三、创建 dockerfile四、构建 Docker

Python使用vllm处理多模态数据的预处理技巧

《Python使用vllm处理多模态数据的预处理技巧》本文深入探讨了在Python环境下使用vLLM处理多模态数据的预处理技巧,我们将从基础概念出发,详细讲解文本、图像、音频等多模态数据的预处理方法,... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

Java操作Word文档的全面指南

《Java操作Word文档的全面指南》在Java开发中,操作Word文档是常见的业务需求,广泛应用于合同生成、报表输出、通知发布、法律文书生成、病历模板填写等场景,本文将全面介绍Java操作Word文... 目录简介段落页头与页脚页码表格图片批注文本框目录图表简介Word编程最重要的类是org.apach