sphinx linux,sphinx使用及其简单配置方法
sphinx使用
进入你要创建文档的目录,例如要创建在目录/home/wwwroot/doc下
cd /home/wwwroot/doc
开始使用向导创建你的文档项目
sphinx-quickstart
程序会提示输入一些选项,如输入根目录,大部分使用默认选项,直接按回车即可。
Enter the root path for documentation.
> Root path for the documentation [.]:
//输入跟目录,直接回车
You have two options for placing the build directory for Sphinx output.
Either, you use a directory "_build" within the root path, or you separate
"source" and "build" directories within the root path.
> Separate source and build directories (y/N) [n]:
//是否分离source和build目录,建议选y,方便管理
Inside the root directory, two more directories will be created; "_templates"
for custom HTML templates and "_static" for custom stylesheets and other static
files. You can enter another prefix (such as ".") to replace the underscore.
> Name prefix for templates and static dir [_]:
//直接回车
The project name will occur in several places in the built documentation.
> Project name: F2E Cookbook
> Author name(s): imbingdian
//输入项目名称
//输入作者名称
The file name suffix for source files. Commonly, this is either ".txt"
or ".rst". Only files with this suffix are considered documents.
> Source file suffix [.rst]: .txt
//档文件的扩展名,默认是.rst
//后面的操作基本回车就好
完成后可以看到doc文件中生了以下目录文件
build--生成文档目录
source--源文件目录
make.bat
makefile
生成html文档
make html
看一下build目录下是不是生成了html文档了?
^_^ enjoy it!
查看demo:http://doc.litejs.com/
sphinx简单配置
source目录下的conf.py文件为sphinx的配置文件。
1)修改文档语言为中文:
找到#language = None,修改为:language ='zh_CN',其它语言见下表
bn – Bengali
ca – Catalan
cs – Czech
da – Danish
de – German
en – English
es – Spanish
fi – Finnish
fr – French
hr – Croatian
it – Italian
ja – Japanese
lt – Lithuanian
nl – Dutch
pl – Polish
pt_BR – Brazilian Portuguese
ru – Russian
sl – Slovenian
tr – Turkish
uk_UA – Ukrainian
zh_CN – Simplified Chinese
zh_TW – Traditional Chinese
2)设置主题
3)其它
还其它更多设置,具体请参考官方文档。
设置好以后,重新make html即可。
扩展阅读:
sphinx linux,sphinx使用及其简单配置方法相关推荐
- 让你提前认识软件开发(51):VC++集成开发环境中Linux下Pclint工程的配置方法及常见错误修改
第3部分 软件研发工作总结 VC++集成开发环境中Linux下Pclint工程的配置方法及常见错误修改 [文章摘要] Pclint是一种C/C++软件代码静态分析工具.它是一种更加严格的编译器,能够发 ...
- 【 Linux 】通用的vim简单配置方法
[ Linux ]Vim的基本配置以及出现问题解决(su认证失败)上次,我用这篇博文的方法去配置了下我的vim,但是后来使用的使用出现了一个问题,就是我必须首先通过命令su进入超级用户状态下才能使用这 ...
- linux 中关于网络的配置方法
配置文件 /etc/hosts(本地主机ip地址映射,可以有多个别名). /etc/services(端口号与标准服务之间的对应关系). /etc/sysconfig/network(设置主机名,网关 ...
- 两种Linux CentOS 6.5 网络配置方法
方法一.修改网络配置文件 cd /etc/sysconfig/network-scripts cp ifcfg-eth0 ./ifcfg-eth0.bak //修改前先备份 第一个以太网卡对应的网络配 ...
- Ubuntu Linux 8.04系统JAVA配置方法
[正文] 1.首先安装JDK java6 在命令行输入 apt-get install sun-java6-jre sun-java6-jdk 可以自行选择是否安装jre java5 在命令行输入 a ...
- atftp 在SUSE Linux中的源代码安装配置方法
tftp协议一般用在PXE启动,常用的有atftp和tftpd-hpa,推荐使用atftp,因为atftp是唯一的免费的符合RFC规范的TFTP服务器. 下载atftp http://down1.ch ...
- xware for linux,Linux版迅雷(Xware)安装配置方法
Linux版迅雷下载请见:Xware下载 解压下载的压缩包 核对MD5或SHA1校验值 解压得到以下三个文件 安装文件 在/usr/local/下创建thunder文件夹,将上面的三个文件放入,然后运 ...
- linux迅雷默认安装目录,Linux版迅雷(Xware)安装配置方法
Linux版迅雷下载请见:Xware下载 解压下载的压缩包 核对MD5或SHA1校验值 解压得到以下三个文件 安装文件 在/usr/local/下创建thunder文件夹,将上面的三个文件放入,然后运 ...
- linux dhcp option43,DHCP option43配置方法
Linux DHCP Server 一.Linux DHCP Server中Option 43选项的写规则 在Liunx系统的DHCP服务器中配置Option 43,Option 43字段要按照十六进 ...
- 宝塔Linux面板Nginx反向代理配置方法
Nginx作为web服务器一个重要的功能就是高性能反向代理.当然你也可以使用Nginx配置正向代理,本文是介绍如何通过宝塔主机面板的网站配置nginx的反向代理.nginx反向代理的指令不需要新增额外 ...
最新文章
- 2021暑假每日一题 【week7 完结】
- Qt for Android调用原生接口打开相机拍照并存储照片
- Nacos源码ServiceManager
- Unity Pixel 人物设计(1)
- GPU Gems1 - 9 有效的阴影体渲染
- python 常见问题汇总(待续)
- vue开发手机页面闪烁_Vue页面加载闪烁问题的解决方法_婳祎_前端开发者
- 巨头切入,或将改变云客服市场
- 2007年网络防病毒评测_序
- java多线程-线程生命周期及状态
- (转)区块链创造了ICO,但是无法守护ICO
- 【教程】批量号码归属地查询可以导出excel表格,手机号码归属地批量查询软件免费版
- Groovy+Spock单元测试
- WEB端工程环境安装
- MSDC 4.3 接口规范(4)
- ViewData与ViewBag比较
- java 加密方式_Get史上最优雅的加密方式!没有之一!
- 信号分析——导数(Java/Matlab)
- 才云 Caicloud 开源 Nirvana:让 API 从对框架的依赖中涅槃重生
- el-tree树形组件拿到所有复选框选中的值