You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Mar 2, 2023. It is now read-only.
The documentation of the attribute form_class in views which inherit from Django's FormView produces the following warning when executing sphinx-build:
WARNING: :1: (WARNING/2) Bullet list ends without a blank line; unexpected unindent.
It took me a while to figure out what the problem is, because there is no reference to the source code which produced this warning.
Looking at the verbose debug output of sphinx-build, I noticed the following:
.. py:attribute:: CustomView.form_class
:module: app.views
Docstring for this attribute
**Form fields:**
* ``field1``: Field1 (:class:`~django.forms.fields.CharField`)
alias of :class:`CustomForm`
So the form fields are appended to the docstring by sphinxcontrib-django and the "alias" is appended because the value of the field in a class. The missing new line between the bullet list and the "alias"-line causes the warning.
The text was updated successfully, but these errors were encountered:
The documentation of the attribute
form_class
in views which inherit from Django's FormView produces the following warning when executing sphinx-build:WARNING: :1: (WARNING/2) Bullet list ends without a blank line; unexpected unindent.
It took me a while to figure out what the problem is, because there is no reference to the source code which produced this warning.
Looking at the verbose debug output of sphinx-build, I noticed the following:
So the form fields are appended to the docstring by sphinxcontrib-django and the "alias" is appended because the value of the field in a class. The missing new line between the bullet list and the "alias"-line causes the warning.
The text was updated successfully, but these errors were encountered: