sphinx创建一个空文档

问题描述

假设以下是我的代码的结构：

   A/
       __init__.py
       B.py
    
  Run.py

我继续安装sphinx和numpydoc扩展。然后，我发出sphinx-quickstart并选择默认值（不要将源代码和生成器分开），然后得到以下文件：

   A/
      docs/
           conf.py
           index.rst
           static
           templates
      __init__.py
      B.py
  Run.py

下一步，我编辑index.rst并添加以下内容：

    .. automodule:: Run
       :members:

然后我按如下方式编辑conf.py：

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

然后我cd进入docs目录并发出make HTML，但是当我打开index.html文件时，我看不到任何文档，而且它是空的。

我搜索了互联网上的所有帖子，但在这里我都找不到。

我想知道有人可以告诉我：

1-如果我在做什么正确？

2-由于我在文档字符串中使用了numpydoc约定，所以这可能就是我不这样做的原因 看到什么了吗？

编辑：我分离了项目和源，并运行sphinx-apidoc -o ./source ..，这为A.rst和modules.rst生成了另外两个rst文件，并且更改了索引.rst因此，但是在运行make HTML之后，我收到警告，没有模块名称A，并且无法从模块A导入B。

A/
      __init__.py
      B.py
      source/
             module.rst
             index.rst
             A.rst
Run.py

我添加的顺便说一句

'sphinx.ext.autodoc','sphinx.ext.napoleon'

到conf.py中的扩展名列表。

这是我的index.rst的内容：

.. toctree::
   :maxdepth: 2
   :caption: Contents:
   
   A
   modules   
   


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

解决方法

暂无找到可以解决该程序问题的有效方法，小编努力寻找整理中！

如果你已经找到好的解决方法，欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@）