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即可。

扩展阅读:

相关文章

  • 阿里云ECS服务器入门使用流程(新手必看教程)

    阿里云ECS服务器入门使用流程(新手必看教程)

    这篇文章主要介绍了阿里云ECS服务器入门使用流程(新手必看教程),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-07-07
  • Linux中openssl/opensslv.h找不到问题的解决方法

    Linux中openssl/opensslv.h找不到问题的解决方法

    最近在安装scrapy过程中碰到了openssl某个文件找不到的问题,通过查找相关的资料进行了解决,下面这篇文章主要给大家分享了关于Linux中openssl/opensslv.h找不到问题的解决方法,需要的朋友可以参考借鉴,下面来一起看看吧。
    2017-07-07
  • 基于Apache Hudi在Google云构建数据湖平台的思路详解

    基于Apache Hudi在Google云构建数据湖平台的思路详解

    这篇文章主要介绍了基于Apache Hudi在Google云构建数据湖平台,本文提供了有关如何使用上述工具构建基本数据管道的基本介绍,需要的朋友可以参考下
    2022-04-04
  • 利用shell find命令删除过期的缓存方法示例

    利用shell find命令删除过期的缓存方法示例

    这篇文章主要介绍了利用shell find命令删除过期的缓存方法,文中给出了详细的示例代码,相信对大家的学习或者工作能带来一定的帮助,需要的朋友们下面来一起看看吧。
    2017-03-03
  • linux 查看文件的属性(ls,lsattr,file,stat)实例详解

    linux 查看文件的属性(ls,lsattr,file,stat)实例详解

    这篇文章主要介绍了linux 查看文件的属性(ls,lsattr,file,stat)实例详解的相关资料,需要的朋友可以参考下
    2017-03-03
  • Centos7.2 编译安装PHP7.0.2的步骤

    Centos7.2 编译安装PHP7.0.2的步骤

    本篇文章主要介绍了Centos7.2 编译安装PHP7.0.2的步骤。小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-06-06
  • Linux 中firewall的使用方法总结

    Linux 中firewall的使用方法总结

    这篇文章主要介绍了Linux 中firewall的使用方法总结的相关资料,这里提供了使用的命令帮助大家学习理解,需要的朋友可以参考下
    2017-08-08
  • Linux下安装tomcat并部署网站(推荐)

    Linux下安装tomcat并部署网站(推荐)

    这篇文章主要介绍了Linux下安装tomcat并部署网站,本文给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-11-11
  • kubelet配置详解及简单实例

    kubelet配置详解及简单实例

    这篇文章主要介绍了kubelet配置详解及简单实例的相关资料,需要的朋友可以参考下
    2017-05-05
  • 安装CentOS 6.x报错

    安装CentOS 6.x报错"Disk sda contains BIOS RAID metadata"解决方法

    今天在安装CentOS6.2的时候,当进到检测硬盘的时候,总是过不去,报错如下: Disk sda contains BIOS RAID metadata, but is not part of any recognized BIOS RAID sets. Ignoring disk sda,真是不知如何解决,下面小编把我的思路分享到脚本之家平台,需要的朋友参考下
    2019-11-11

最新评论