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
- Directives
- Templates
- Structure
- Custom Filters, Tests, and Globals
- Context
PythonObjectPythonObject.appPythonObject.childrenPythonObject.displayPythonObject.docstringPythonObject.get_context_data()PythonObject.idPythonObject.importedPythonObject.include_pathPythonObject.inheritedPythonObject.is_private_memberPythonObject.is_special_memberPythonObject.is_top_level_objectPythonObject.is_undoc_memberPythonObject.jinja_envPythonObject.member_orderPythonObject.namePythonObject.objPythonObject.optionsPythonObject.output_dir()PythonObject.output_filename()PythonObject.qual_namePythonObject.render()PythonObject.renderedPythonObject.short_namePythonObject.summaryPythonObject.typePythonObject.url_root
PythonFunctionPythonMethodPythonPropertyPythonDataPythonAttributeTopLevelPythonObjectPythonModulePythonPackagePythonClassPythonException