sphinx使用及其简单配置方法

 更新时间:2011年04月25日 00:11:10   作者:  
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)设置主题

找到html_theme = 'default',修改default即可。目前官方提供的主题见http://sphinx.pocoo.org/theming.html#builtin-themes

3)其它

还其它更多设置,具体请参考官方文档

设置好以后,重新make html即可。

扩展阅读:

相关文章

  • 在Linux配置自启动jar包方式

    在Linux配置自启动jar包方式

    这篇文章主要介绍了在Linux配置自启动jar包方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • 详解linux系统目录sys,tmp,usr,var!

    详解linux系统目录sys,tmp,usr,var!

    在本篇文章里小编给大家详解了关于linux系统目录,sys,tmp,usr,var!的相关知识点内容,有兴趣的朋友们参考下。
    2019-06-06
  • linux下实现web数据同步的四种方式(性能比较)

    linux下实现web数据同步的四种方式(性能比较)

    这篇文章主要介绍了linux下常用的四种web数据同步方法,并且说明了每个方法的功能与优势,需要的朋友可以参考下
    2013-09-09
  • 使用stress命令进行Linux CPU压力测试的实现方法

    使用stress命令进行Linux CPU压力测试的实现方法

    在Linux系统中,有许多工具可以用来进行CPU压力测试,其中一个非常常用的工具就是stress命令,stress命令是一个简单而强大的压力测试工具,可以模拟系统在高负载情况下的运行状态,帮助我们评估系统的稳定性和性能,在本文中,我们将探讨如何使用stress命令进行 CPU压力测试
    2024-08-08
  • Linux配置免密登录单机和全分布详细教程

    Linux配置免密登录单机和全分布详细教程

    大家好,本篇文章主要讲的是Linux配置免密登录单机和全分布详细教程,感兴趣的同学赶快来看一看吧,对你有帮助的话记得收藏一下哦
    2021-12-12
  • CentOS8下的root密码快速修改方法

    CentOS8下的root密码快速修改方法

    这篇文章主要介绍了CentOS8版本的root密码快速修改方法,本文图文并茂通过实例讲解的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-03-03
  • CentOS下使用LibreOffice实现文档格式的转换方式

    CentOS下使用LibreOffice实现文档格式的转换方式

    项目需求,对上传的文档进行一些预处理,如果用户上传了doc格式的文档,需要将其处理为docx或者pdf格式,以便后续的流程对文档内容进行提取。接下来通过本文给大家分享CentOS下使用LibreOffice实现文档格式的转换,感兴趣的朋友一起看看吧
    2019-07-07
  • Apache服务的主要目录和配置文件详解

    Apache服务的主要目录和配置文件详解

    这篇文章主要介绍了Apache服务的主要目录和配置文件详解,需要的朋友可以参考下
    2017-05-05
  • CentOS8  网卡配置文件

    CentOS8 网卡配置文件

    CentOS8更新最大的改动就是网卡这一块了,接下来就配置一下网卡;感兴趣的朋友跟随小编一起看看吧
    2019-10-10
  • Apache POI简介及应用场景

    Apache POI简介及应用场景

    Apache POI 是一个处理Miscrosoft Office各种文件格式的开源项目,我们可以使用POI在Java程序中对Miscrosoft Office各种文件进行读写操作,本文给大家介绍Apache POI简介,感兴趣的朋友一起看看吧
    2023-11-11

最新评论