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

    * "PythonFunction"

      * "PythonFunction.args"

      * "PythonFunction.member_order"

      * "PythonFunction.overloads"

      * "PythonFunction.properties"

      * "PythonFunction.return_annotation"

      * "PythonFunction.type"

    * "PythonMethod"

      * "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.output_dir()"

      * "TopLevelPythonPythonMapper.output_filename()"

      * "TopLevelPythonPythonMapper.submodules"

      * "TopLevelPythonPythonMapper.subpackages"

    * "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"
