1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
Changelog
=========
Version 2.5 (2023-09-26)
------------------------
* Drop support for sphinx < 3.4.0
* [ `#45 <https://github.com/edoburu/sphinxcontrib-django/issues/45>`_ ] Fix rendering of inheritance diagrams
* Drop support for Python 3.7
Version 2.4 (2023-07-02)
------------------------
* [ `#39 <https://github.com/edoburu/sphinxcontrib-django/issues/39>`_ ] Fix table names of abstract models (`@insspb <https://github.com/insspb>`__)
* [ `#41 <https://github.com/edoburu/sphinxcontrib-django/issues/41>`_ ] Fix rendering of iterable choices (`@insspb <https://github.com/insspb>`__)
Version 2.3 (2023-04-12)
------------------------
* Add support for Django 4.2
* Drop support for Django 4.0
Version 2.2 (2023-03-01)
------------------------
* [ `#35 <https://github.com/edoburu/sphinxcontrib-django/issues/35>`_ ] Fix interference with other ``autodoc-skip-member`` signal handlers
Version 2.1 (2023-03-01)
------------------------
* [ `#32 <https://github.com/edoburu/sphinxcontrib-django/issues/32>`_ ] Fix rendering of nested directives in model parameter documentation
Version 2.0 (2023-01-02)
------------------------
Merge fork `sphinxcontrib_django2 <https://pypi.org/project/sphinxcontrib-django2/>`_ back into `sphinxcontrib_django <https://pypi.org/project/sphinxcontrib-django/>`_.
*Versions 0.6 until 1.6 were releases of the fork. With version 2.0, the changes are included in the original package again.*
Version 1.6 (2022-11-24)
------------------------
* Add inline docstrings of model fields to parameter documentation of models
* Add support for Python 3.11
* Add support for Django 4.1
* Drop support for Django 2.2
Version 1.5 (2022-01-05)
------------------------
* Support string foreign keys of abstract models
Version 1.4 (2022-01-05)
------------------------
* Do not reference related names of abstract models
* Drop support for Python 3.6
* Drop support for Django 3.1
* Add support for Django 4.0
Version 1.3 (2021-11-20)
------------------------
* Fix ``AttributeError`` when ``django.contrib.contenttypes`` is not in ``INSTALLED_APPS``
* Emit sphinx event ``django-configured`` after ``django.setup()`` is finished to allow monkeypatching django during
documentation build
Version 1.2 (2021-11-08)
------------------------
* Add support for Python 3.10
* Add support for Django 3.2
* Drop support for Django 3.0
* Add option ``django_show_db_tables`` to list the database table names of Django models in their docstring
Version 1.1.1 (2021-03-02)
--------------------------
* Support django.db.models.JSONField
* List choices of choice fields
Version 1.1 (2021-03-02)
------------------------
* Add support for Python 3.9
* Add support for django-mptt with Django >=3.1
* Append initial docstrings to attributes
* Fix mutable references of pre-commit hooks
* Fix tests for sphinx 3.5.0
Version 1.0.2 (2021-02-02)
--------------------------
* Add support for GenericForeignKey field of django.contrib.contenttypes
Version 1.0.1 (2021-02-02)
--------------------------
* Fix Intersphinx mappings to AppConfig and Manager classes
Version 1.0 (2021-01-24)
------------------------
* Fix more Intersphinx mappings to Django classes
* Refactor package structure
* Refactor tests
* Improve docstring output
* Improve handling of related and reverse related fields
* Add documentation for sphinxcontrib_django itself
* Improve docstrings of iterable data
* Add config value for Django settings
* Load autodoc and intersphinx extensions in setup()
* Provide default intersphinx_mapping
* Return extension metadata in setup()
* Move dev dependencies from Pipfile to setup.py
* Add readthedocs.io integration
Version 0.7 (2020-11-30)
------------------------
* Fix Intersphinx mappings to Django classes
* 100% test coverage
Version 0.6 (2020-11-16)
------------------------
* Fix deferred attribute for Django >=2.1, <3.0
* Django: Drop support for [1.11, 2.0], add support for [2.2, 3.0, 3.1]
* Python: Drop support for [2.7, 3.5], add support for [3.6, 3.7, 3.8]
* Replace force_text by force_str (deprecated in Django 4.0)
* Improved test coverage
* Support for Django ModelFields
Version 0.5.1 (2020-01-26)
--------------------------
* Fix deferred attribute for Django 3.0.
Version 0.5 (2019-08-09)
------------------------
* Model fields always show verbose name if present.
* Model fields are skipped when they are already documented.
* Support "self" in foreign keys.
* Allow ``:setting:`` registration to fail
* Fixed ``runtests.py`` for Django 2.2
* Reformatted all source code with black, isort and flake8
Version 0.4 (2018-07-26)
------------------------
* Fixed Django 2.0 behavior when foreignkeys are strings.
Version 0.3.1 (2018-03-11)
--------------------------
* Fixed Python 2 issue with ``list.clear()``.
Version 0.3 (2018-02-19)
------------------------
* Fixed Django 2.0 support
* Fixed missing form fields
* Fixed handling of ``ForeignKey('modelname')``
Version 0.2.1 (2018-01-02)
------------------------
* Fixed bad packaging of 0.2
Version 0.2 (2018-01-02)
------------------------
* Support more Python versions (removed f-strings)
version 0.1 (2017-12-07)
------------------------
* Initial version
|
