Skip to content
Back to top
View this page

# `autodoc2.sphinx.summary`

## Module Contents

### Classes

`AutodocSummary` |

### API

class autodoc2.sphinx.summary.AutodocSummary(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

  Bases: `sphinx.util.docutils.SphinxDirective`

  Initialization

  has_content = True
  required_arguments = 0
  optional_arguments = 0
  final_argument_whitespace = False
  option_spec: ClassVar[dict[str, Any]] = None
  run() → list[docutils.nodes.Node]