Sphinx 是一个基于Python的文档生成项目,采用了 reStructuredText 作为文档写作语言 ,不过也可以通过模块支持其他格式.
(Sphinx标记结构)[ http://www.pythondoc.com/sphinx/markup/ ]
pip install sphinx sphinx-autobuild
#创建目录cd /path/to/projectmkdir docs#sphinx工作目录基本配置cd docs#可以回车按默认配置来写sphinx-quickstart#quickstart 后生成的目录结构readthedocs│ make.bat│ Makefile├─build└─source │ conf.py │ index.rst ├─_static └─_templates# 默认会有一个index.rst,make html用来生成html页面make html
在 source 目录下新建 hello.rst :
hello,world======================================
index.rst修改如下:
Contents:.. toctree:: :maxdepth: 2 hello
make html 后效果如下:
pip install recommonmark
from recommonmark.parser import CommonMarkParsersource_parsers = { '.md': CommonMarkParser,}source_suffix = ['.rst', '.md']
pip install sphinx_rtd_theme
import sphinx_rtd_themehtml_theme = "sphinx_rtd_theme"html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
doc