这篇文章主要为大家展示了“Python中Sphinx怎么用”，内容简而易懂，条理清晰，希望能够帮助大家解决疑惑，下面让小编带领大家一起研究并学习一下“Python中Sphinx怎么用”这篇文章吧。

目前成都创新互联已为成百上千家的企业提供了网站建设、域名、网站空间、成都网站托管、企业网站设计、海西网站维护等服务，公司将坚持客户导向、应用为本的策略，正道将秉承"和谐、参与、激情"的文化，与客户和合作伙伴齐心协力一起成长，共同发展。

描述

使用 pip 安装sphinx后，按照教程建立了一个新的py文件，如下

# run.py
def run(name):
  """
  this is how we run
  :param name name of people who runs
  """
  print(name, 'is running')

随后新建一个目录，使用 sphinx-quickstart 新建了sphinx环境，此时目录结构如下：

- doc
  - Makefile
 - build/
 - make.bat
 - source/
- run.py

此时进入 source目录，在conf.py 中添加文件路径，如下：

import os
import sys
sys.path.insert(0, os.path.abspath('../..'))

然后在 doc 下执行下面命令：

make html
or
sphinx-build -b html ./doc/source ./doc/build

发现两个命令都可以正常生成文档的模版，但并没有生成注释；即有生成的html，但没有代码的注释/API文档

尝试解决

开始以往是版本不一致，就重新建了virtualenv，还是不行；

使用了一个docker镜像，重试，结果是同样的错误

尝试看非官方的教程，发现还需要更改 source 下的 index.rst；

例如我们的代码文件是 run.py ，需要把他加到 index.rst中，如下（run就是模块名称）：

API
===
.. automodule:: run
  :members:

再次执行，发现还有错，只不过提示不一样了：提示

Unknown directive type “automodule” or “autoclass”

谷歌之，发现还要改一个配置的地方；位于 conf.py 里，增加一个扩展……如下：

extensions = [
    'sphinx.ext.autodoc'
]

以上是“Python中Sphinx怎么用”这篇文章的所有内容，感谢各位的阅读！相信大家都有了一定的了解，希望分享的内容对大家有所帮助，如果还想学习更多知识，欢迎关注创新互联行业资讯频道！

本文题目：Python中Sphinx怎么用-创新互联
路径分享：http://chengdu.cdxwcx.cn/article/cssdpi.html