Skip to content

Generated documentation leaves extraneous trailing whitespace on certain empty lines #558

@jonathandung

Description

@jonathandung

When I use sphinx-autoapi to generate my API reference, doc8 complains that there are some instances of trailing whitespace. They are all of the following form:

.. py:class:: ClassName

   <Optionally bases + two blank lines>
   
   This is the docstring of the `__init__` method of the class. The above line in the source is not empty; it contains three spaces.

Relevant snippet of my conf.py:

extensions = ['sphinx.ext.napoleon', 'sphinx.ext.viewcode', 'autoapi.extension']
autoapi_file_patterns = ['*.pyi']
autoapi_python_class_content = 'both'
autoapi_member_order = 'groupwise'
autoapi_options = ['members', 'undoc-members', 'show-inheritance', 'show-module-summary', 'special-members']

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions