Skip to content

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

v2.0

Compare
Choose a tag to compare
Loading
@timobrembeck timobrembeck released this 02 Jan 22:19
· 59 commits to main since this release
e5a38d0

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

Morty Proxy This is a proxified and sanitized view of the page, visit original site.