sphinx教程,免费搭建你的文档网站

如何建立免费的文档

Sphinx 本地环境搭建和编写文档

pip install sphinx # 安装sphinx
sphinx是使用最广泛的文档框架,快速生成文档资源,是基于python环境的模块,这里你需要拥有python3.6以上的环境。

pip install sphinx_rtd_theme # 安装readthedocs主题
本主题图一示例的主题,也是比较常见的,而默认的是flask官方文档的主题,这里建议使用sphinx_rtd_theme主题。我们需要在conf.py中将主题改为sphinx_rtd_theme。

1
2
3
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

原来的html_theme = 'alabaster' # 这里注释掉
开始创建
sphinx-quickstart
这个命令可以快速创建文档的,这里需要填写一些文档的信息,包含版本、名称、作者和语言等等。

1
2
3
4
5
6
> Separate source and build directories (y/n) [n]:y
> Project name: scrapy-cookbook
> Author name(s): Xiong Neng
> Project version []: 0.2
> Project release [1.0]: 0.2.2
> Project language [en]: zh_CN

原文转自 karl科技站——https://xwtech.site/?p=92

小伟科技 wechat
python爱好者公众号—每日学习python必备
欢迎打赏支持!