我正在尝试使用sphinx自动生成python项目的文档。但是,我无法从doscstrings生成文档。以下是我已采取的步骤
在docs目录中,我执行
sphinx-quickstart
我回答
Separate source and build directories (y/n) [n]: y
Rest是标准默认值。现在文档看起来像
在文档内部的conf.py中,我进行了以下修改
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
extensions = ['sphinx.ext.autodoc','sphinx.ext.todo','sphinx.ext.coverage']
然后,在我运行的docs目录中
sphinx-apidoc -f -o source/ ../axolotl/
之后,我运行
make html
在docs目录中,我得到以下日志
没有任何子文件夹的列表
另一个其他modules.html列出了文件夹,但未生成文档表格文档字符串
自从过去两天以来,我已经引用了各种stackoverflow链接和博客,请有人指出我要去哪里错吗?
其他详细信息:
****通过按@mzn的建议修复sys路径并安装n个必需的模块,解决了较早的问题**** **问题2:Index.rst如下所示** ..
axolotl documentation master file, created by
sphinx-quickstart on Wed Nov 6 18:45:01 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to axolotl's documentation!
===================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`