Skip to content

section heading in function doc string triggers error: Unexpected section heading #10887

Description

@Phillip-M-Feldman

Describe the bug

The presence of a section heading in a doc string triggers the error "unexpected doc string". Is this something that is supposed to work? When a function's doc string is very long, the ability to divide it into sections is essential.

How to Reproduce

Put a section heading in the doc string of a function or method.

Expected behavior

No response

Your project

N/A

Screenshots

No response

OS

Windows 10

Python version

3.8.8

Sphinx version

5.2.2

Sphinx extensions

No response

Extra tools

No response

Additional context

No response

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions