Reference Guide

The reference guide contains a detailed description of the configuration options, directives, and templates included in AutoAPI. To learn how to use AutoAPI, see the Tutorials.

• Configuration Options
  • Customisation Options
    • Events
  • Advanced Options
  • Suppressing Warnings
• Directives
  • Autodoc-Style Directives
    • .. autoapimodule::
    • .. autoapiclass::
    • .. autoapiexception::
    • .. autoapifunction::
    • .. autoapidata::
    • .. autoapimethod::
    • .. autoapiattribute::
  • Inheritance Diagrams
    • .. autoapi-inheritance-diagram::
• Templates
  • Structure
  • Custom Filters, Tests, and Globals
  • Context
    • PythonPythonMapper
      • PythonPythonMapper.name
      • PythonPythonMapper.id
      • PythonPythonMapper.children
      • PythonPythonMapper.display
      • PythonPythonMapper.docstring
      • PythonPythonMapper.inherited
      • PythonPythonMapper.is_callable
      • PythonPythonMapper.is_private_member
      • PythonPythonMapper.is_special_member
      • PythonPythonMapper.is_undoc_member
      • PythonPythonMapper.language
      • PythonPythonMapper.member_order
      • PythonPythonMapper.summary
    • PythonFunction
      • PythonFunction.args
      • PythonFunction.is_callable
      • PythonFunction.member_order
      • PythonFunction.overloads
      • PythonFunction.properties
      • PythonFunction.return_annotation
      • PythonFunction.type
    • PythonMethod
      • PythonMethod.is_callable
      • PythonMethod.member_order
      • PythonMethod.properties
      • PythonMethod.type
    • PythonProperty
      • PythonProperty.annotation
      • PythonProperty.member_order
      • PythonProperty.properties
      • PythonProperty.type
    • PythonData
      • PythonData.annotation
      • PythonData.member_order
      • PythonData.type
      • PythonData.value
    • PythonAttribute
      • PythonAttribute.member_order
      • PythonAttribute.type
    • TopLevelPythonPythonMapper
      • TopLevelPythonPythonMapper.all
      • TopLevelPythonPythonMapper.classes
      • TopLevelPythonPythonMapper.functions
      • TopLevelPythonPythonMapper.top_level_object
    • PythonModule
      • PythonModule.type
    • PythonPackage
      • PythonPackage.type
    • PythonClass
      • PythonClass.args
      • PythonClass.attributes
      • PythonClass.bases
      • PythonClass.classes
      • PythonClass.constructor
      • PythonClass.constructor_docstring
      • PythonClass.docstring
      • PythonClass.member_order
      • PythonClass.methods
      • PythonClass.overloads
      • PythonClass.properties
      • PythonClass.type
    • PythonException
      • PythonException.member_order
      • PythonException.type