1

我正在尝试为我正在制作的一些软件创建文档，但遇到了以下问题。我在这里从 param.Parameterized repo继承的任何类最终都会在我编写的 Docstring 内容之后以纯文本形式编写看起来像 param 的“迷你”文档。

如上面的屏幕截图所示，有一个小例子，这是产生的：


Parameters

    exampleType

        Example parameter

Attributes

    exampleType

        Example attribute
    [1;32mParameters of ‘Example’
    =======================
    [0m
    [1;31mParameters changed from their default values are marked in red.[0m
    [1;36mSoft bound values are marked in cyan.[0m
    C/V= Constant/Variable, RO/RW = ReadOnly/ReadWrite, AN=Allow None
    [1;34mName Value Type Bounds Mode [0m
    test False Boolean (0, 1) V RW
    [1;32mParameter docstrings:
    =====================[0m
    [1;34mtest: < No docstring available >[0m

我的conf.py包含：

import os
import sys

sys.path.insert(0, os.path.abspath("."))

project = "example"
copyright = ""
author = ""

extensions = [
    "sphinx.ext.napoleon",
    "sphinx.ext.autodoc",
    "sphinx.ext.todo",
    "sphinx.ext.coverage",
    "numpydoc",
]

numpydoc_show_class_members = False
numpydoc_show_inherited_class_members = False

autodoc_default_options = {
    "show-inheritance": False,
}

templates_path = ["_templates"]

exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

html_theme = "sphinx_rtd_theme"

html_static_path = ["_static"]

我的 index.rst 是：

Welcome to Documentation!
========================================

.. autoclass:: example.Example
   :members: example_method

我的 example.py 包含：

import param

class Example(param.Parameterized):
    """Example Class.

    Parameters
    ----------
    example : Type
        Example parameter


    Attributes
    ----------
    example : Type
        Example attribute

    """

    test = param.Boolean()

    def __init__(self):

        testing = True

    def example_method(self, example):
        """Example Method.

        Parameters
        ----------
        example : Type
            Example parameter


        Returns
        ----------
        None

        """

        testing = True

我不确定问题出在 param 类还是 sphinx 上，所以如果有人知道如何关闭文档的这个额外部分，我将不胜感激。

构建的文档：

构建的文档

4

0 回答 0