In 43eea5b41d84ab70fb3c71e1d7d77aa11ff1cf18, I added a template filter with a docstring that was rendered as reStructuredText in admindocs, Django's automatic documentation generator.
However, the following docstring:
"""
Return the domain name of the given URL. For example::
{{ 'http://example.org/stuff'|domainname }}
would display ``example.org``.
"""
Raises the error "Literal block expected; none found." on line 2 of the docstring in admindocs (the same error is also raised throughout django-crispy-forms' own docs). No amount of fiddling with things seemed to fix it, except for adding another paragraph at the beginning of the docstring, like so:
"""
Return the domain name of the given URL.
For example::
{{ 'http://example.org/stuff'|domainname }}
would display ``example.org``.
"""
Debugging this was quite frustrating.
I'm not sure if the bug has something to do with my app's particular dependency configuration, or a bug in admindocs, docutils, or somewhere else entirely.
It's also possible that this is due to the fact that my development machine at the time was Windows, and it could be due to some weird CR/LF conversion issues.
In 43eea5b41d84ab70fb3c71e1d7d77aa11ff1cf18, I added a template filter with a docstring that was rendered as reStructuredText in admindocs, Django's automatic documentation generator.
However, the following docstring:
Raises the error "Literal block expected; none found." on line 2 of the docstring in admindocs (the same error is also raised throughout django-crispy-forms' own docs). No amount of fiddling with things seemed to fix it, except for adding another paragraph at the beginning of the docstring, like so:
Debugging this was quite frustrating.
I'm not sure if the bug has something to do with my app's particular dependency configuration, or a bug in admindocs, docutils, or somewhere else entirely.