狮身人面像被困在读源指数上

时间:2016-06-03 15:02:47

标签: python python-sphinx autodoc

当我输入make html时,Sphinx卡在阅读段上。

通过更改" asp"中的名称改变它被卡住的百分比。我有它的范围从100%到25%。 以下是我在运行make html时在终端中看到的示例:

make html
sphinx-build -b html -d _build/doctrees   . _build/html
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.2.1
loading pickled environment... done
building [html]: targets for 2 source files that are out of date
updating environment: 0 added, 2 changed, 0 removed
reading sources... [ 50%] asp                                                                                                  

如前所述,50%不是常数。通过更改asp.rst文件的名称,它会改变我得到的百分比。但它从未超越它。

这是我的asp.rst文件:

 .. _asp:

 TEST123
 =======


.. automodule:: rcegui
.. module:: RCEController
.. autoclass:: RCE_Control_MainWindow
    :members:

这是我的index.rst文件:

Welcome to GUI's documentation!
===============================

Contents:

.. toctree::
   :maxdepth: 2

   asp

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

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

这是conf.py:

import sys
import os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.append(os.path.abspath('../'))

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.doctest',
'sphinx.ext.coverage',
]

删除coverage扩展名也改变了阅读百分比。但它仍然卡住了。这似乎是由RCEController文件引起的,该文件产生GUI并需要用户输入。

2 个答案:

答案 0 :(得分:1)

.. _asp:

的开头添加一行asp.rst
.. _asp:

TEST123
=======

.. automodule:: rcegui
.. module:: RCEController
.. autoclass:: RCE_Control_MainWindow
   :members:

表示index.rst

Welcome to GUI's documentation!
===============================

Contents:

.. toctree::
   :maxdepth: 2

   asp

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

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

请使用正确的缩进空格行按照确切的代码。

例如,在rst中,标题和下划线的构成应该具有相同的长度。

TEST123
=======

答案 1 :(得分:0)

所以我最终检查了--init--.py,但它没有我所调用的程序所需的所有文件。所以在添加丢失的文件并重新启动它之后。 Sphinx能够毫无错误地运行。我不知道是什么修复它,但我觉得它是将缺少的文件添加到--init--.py文件中。