Sphinx使用总结

最新推荐文章于 2024-01-26 18:20:10 发布

fK0pS

最新推荐文章于 2024-01-26 18:20:10 发布

阅读量198

点赞数

文章标签：经验分享

本文链接：https://blog.csdn.net/Hodors/article/details/128641263

版权

文章介绍了如何使用Sphinx构建项目文档，包括通过pip安装Sphinx和sphinx_rtd_theme，初始化项目，配置conf.py以引入代码路径，使用sphinx-apidoc自动生成文档结构，编辑index.rst并构建HTML文档的过程。

摘要由CSDN通过智能技术生成

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里边】