v2.5

sphinxcontrib-django v2.5

🐛 Bug Fixes

• [ #45 ] Fix rendering of inheritance diagrams

🚧 Chores

• Drop support for Python 3.7
• Drop support for sphinx < 3.4.0
• Add type annotations
• Improve code quality

Compare changes: v2.4 → v2.5

Installation

pip install sphinxcontrib-django==2.5

Contributors

@WhyNotHugo @timobrembeck

v2.4

sphinxcontrib-django v2.4

💡 New Features

• Add new setting django_show_db_tables_abstract to include table names in abstract models (defaults to False)
• Add new setting django_choices_to_show to control how many iterable choices are displayed (defaults to 10)

🐛 Bug Fixes

• [ #39 ] Fix table names of abstract models when django_show_db_tables is True
• [ #41 ] Fix rendering of empty values in iterable choices

Compare changes: v2.3 → v2.4

Installation

pip install sphinxcontrib-django==2.4

Contributors

@insspb @timoludwig

v2.3

sphinxcontrib-django v2.3

🚧 Chores

• Add support for Django 4.2
• Drop support for Django 4.0

Compare changes: v2.2 → v2.3

Installation

pip install sphinxcontrib-django==2.3

Contributors

@timoludwig

v2.2

sphinxcontrib-django v2.2

🐛 Bug Fixes

• [ #35 ] Fix interference with other autodoc-skip-member signal handlers

Compare changes: v2.1 → v2.2

Installation

pip install sphinxcontrib-django==2.2

Contributors

@timoludwig

v2.1

sphinxcontrib-django v2.1

🐛 Bug Fixes

• [ #32 ] Fix rendering of nested directives in model parameter documentation

Compare changes: v2.0 → v2.1

Installation

pip install sphinxcontrib-django==2.1

Contributors

@timoludwig

v2.0

sphinxcontrib-django v2.0

Merge fork timoludwig/sphinxcontrib_django2 back into edoburu/sphinxcontrib_django.

💡 New Features

• Add inline docstrings of model fields to parameter documentation of models
• Support string foreign keys of abstract models
• Emit sphinx event django-configured after django.setup() is finished to allow monkeypatching django during
  documentation build
• Add option django_show_db_tables to list the database table names of Django models in their docstring
• Support django.db.models.JSONField
• List choices of choice fields
• Append initial docstrings to attributes
• Add support for GenericForeignKey field of django.contrib.contenttypes
• Support for Django ModelField

🐛 Bug Fixes

• Fix AttributeError when django.contrib.contenttypes is not in INSTALLED_APPS
• Fix Intersphinx mappings to AppConfig and Manager classes
• Fix Intersphinx mappings to Django classes
• Fix deferred attribute for Django >=2.1, <3.0
• Replace force_text by force_str (deprecated in Django 4.0)

🚧 Chores

• Django: Drop support for [1.11, 2.0, 2.1], add support for [3.2, 4.0, 4.1]
• Python: Drop support for [2.7, 3.5, 3.6], add support for [3.7, 3.8, 3.9, 3.10, 3.11]
• Refactor package structure
• Refactor tests
• Return extension metadata in setup()
• Deploy documentation to https://sphinxcontrib-django.rtfd.io
• 100% test coverage

Installation

pip install sphinxcontrib-django==2.0

Contributors

@timoludwig