1、安装sphinx
pip3 install -U sphinx
2、安装现成的主题
pip3 install sphinx-rtd-theme
3、使用向导 制作一个文档
sphinx-quickstart
4、在文档的配置中使用主题
#引用主题
import sphinx_rtd_theme
#设置扩展
extensions = [
...
"sphinx_rtd_theme"
...
]
#设置主题名称
html_theme = "sphinx_rtd_theme"
#设置主题选项
html_theme_options = {
'canonical_url': '',
# 'analytics_id': 'UA-XXXXXXX-1', # Provided by Google in your dashboard
'logo_only': False,
'display_version': True,
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
# 'vcs_pageview_mode': '',
# 'style_nav_header_background': 'white',
# Toc options
'collapse_navigation': True,
'sticky_navigation': True,
'navigation_depth': 4,
'includehidden': True,
'titles_only': False
}
5、输出HTML
./make.bat html
6、输出 Latex
./make.bat latex
7、生成PDF需要使用latexmk 安装windows版本 miktex( https://miktex.org/ )
8、安装Perl (http://strawberryperl.com/)
9、制作PDF(过程中自动从清华镜像下载latexmk所需的perl库,比较多,耐心等待)
cd build\latex
.\make.bat
来源:oschina
链接:https://my.oschina.net/u/53041/blog/3191497