Sphinx AutoAPI

• Tutorials
  • Setting up Automatic API Documentation Generation
• How-to Guides
  • How to Customise Layout Through Templates
  • How to Customise the Index Page
  • How to Configure Where Documentation Appears in the TOC Tree
  • How to Transition to Autodoc-Style Documentation
  • How to Transition to Manual Documentation
  • How to Include Type Annotations as Types in Rendered Docstrings
• Configuration Options
  • Customisation Options
  • Advanced Options
  • Suppressing Warnings
  • autoapi_dirs
  • autoapi_type
  • autoapi_template_dir
  • autoapi_file_patterns
  • autoapi_generate_api_docs
• Directives
  • Autodoc-Style Directives
  • Inheritance Diagrams
• Templates
  • Structure
  • Custom Filters, Tests, and Globals
  • Context
• Design Reference
  • Python
  • .NET
  • Goals
  • Introduction
  • Proposed Architecture
  • Examples
  • Other Ideas
• Release Process
  • Pre-Checks
  • Preparation
  • Release