python sphinx 自动生成文档_sphinx automodule-CSDN博客

本文链接：https://blog.csdn.net/MyCodecOdecoDecodE/article/details/79242354

本文档介绍了如何使用Python的Sphinx工具自动生成项目文档，包括安装Sphinx、创建项目结构、添加Python文件、配置conf.py、编辑reStructuredText（rst）文件，以及通过makefile生成HTML文档。Sphinx通过解析Python文件的docstring生成结构化的文档，方便管理和维护。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

python sphinx 自动生成文档

借鉴：http://blog.csdn.net/preyta/article/details/73647937
在此基础上进行修改扩展

前言：

sphinx是python支持的一种文档自动生成工具，仅需少量操作，就可以把docstring注释生成文档，文档可以是html格式，latex格式，pdf格式等。

安装：

使用pip安装。如果连pip都没有，请先安装anoconda。

$ pip install sphinx

创建项目

创造一个sphinx文件夹，输入以下指令：

$ sphinx-quickstart

影响比较大的有下面几条：


 # 将source文件夹与build文件夹分离，建议选y
> Separate source and build directories (y/n) [n]: y

 # 自动插入模块中的docstring注释，不用想，无脑y
> autodoc: automatically insert docstrings from modules (y/n) [n]: y

 # 是否让文件中包含你的源代码，可酌情选择
> viewcode: include links to the source code of documented Python objects (y/n) [n]: y

输入完后，默认的目录就生成了，目录结构如下：

$ ls -l
total 5
drwxr-xr-x 1 Administrator 197121   0 二月  2 16:47 build/
-rw-r--r-- 1 Administrator 197121 806 二月  2 16:47 make.bat
-rw-r--r-- 1 Administrator 197121 608 二月  2 16:47 Makefile
drwxr-xr-x 1 Administrator 197121   0 二月  2 16:47 source/<