无法使用Sphinx将类初始化doc字符串导入网站

时间:2019-01-16 09:57:33

标签: python-sphinx

我创建了自定义类。我的Python文件具有以下格式的多个类。

class First():

  def __init__(arg1, arg2,arg3 ....):
   arg1=arg1
   arg2=arg2 and so on 
  """
   :arg1: arg1
   :arg2: arg2
  """
  def execute():
   codes--
class Second():
  def __init__(arg1, arg2, arg3 ....):
    arg1=arg1
    arg2=arg2 and so on 
  """
   :arg1: arg1
   :arg2: arg2
  """
  def execute():
   codes--

我在两个类的每个init方法中都添加了文档字符串。

我的index.rst在下面。

Code document
====================================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   Code

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

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

和下面的code.rst。

Custom Operators Documentation
=====================================

.. automodule:: operators.python_file_name
.. autoclass:: operators.python_file_name.First

我没有收到错误消息,但是我得到的网站没有任何参数,包括我添加到Python脚本中的文档字符串。

0 个答案:

没有答案