Sphinx使用总结
第一步:
pip install sphinx
pip install sphinx_rtd_theme
第二步:
cd project/doc
第三步:
sphinx-quickstart
第四步:配置conf.py
import os
import sys
sys.path.insert(0, os.path.abspath(r'D:\PythonProject\code'))
html_theme = 'sphinx_rtd_theme'
extensions = ['sphinx.ext.autodoc']
第五步: 在doc目录下执行
sphinx-apidoc -o source "D:/PythonProject/code"
第六步:修改index.rst 文件
.. toctree::
:maxdepth: 2
:caption: Contents:
modules
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
第七步:在doc目录下执行make html,就会生成html文档,打开html文档,就可以了【注意脚本一定要放在main里边】
.\make clean
.\make html