Sphinx extension for Django apps

sphinxcontrib-django is a sphinx extension which improves the documentation of Django apps.

Documentation

• README
  • Features
  • Installation
  • Configuration
  • Advanced Usage
  • Contributing
• Source Code Reference
  • setup()
  • Docstrings
    • autodoc_skip()
    • improve_docstring()
    • setup()
    • setup_django()
    • Field Utilities
      • get_field_type()
      • get_field_verbose_name()
      • get_model_from_string()
    • Attributes
      • get_field_details()
      • improve_attribute_docstring()
    • Classes
      • add_model_parameters()
      • improve_class_docstring()
      • improve_form_docstring()
      • improve_model_docstring()
    • Data
      • improve_data_docstring()
    • Methods
      • improve_method_docstring()
    • Patches
      • patch_django_for_autodoc()
    • Config
      • CHOICES_LIMIT
      • EXCLUDE_MEMBERS
      • INCLUDE_MEMBERS
  • Roles
    • add_default_intersphinx_mappings()
    • setup()

Indices and tables

• Index

• Module Index