#16863: Multiple "invalid option block" errors when building docs
-------------------------------------+-------------------------------------
Reporter: carljm | Owner: nobody
Type: | Status: closed
Cleanup/optimization | Component: Documentation
Milestone: | Severity: Normal
Version: SVN | Keywords:
Resolution: fixed | Has patch: 0
Triage Stage: | Needs tests: 0
Unreviewed | Easy pickings: 0
Needs documentation: 0 |
Patch needs improvement: 0 |
UI/UX: 0 |
-------------------------------------+-------------------------------------
Changes (by carljm):
* status: new => closed
* resolution: => fixed
Comment:
In [16842]:
{{{
#!CommitTicketReference repository="" revision="16842"
Fixed #16863 -- Corrected ReST markup to avoid errors building docs.
Although directives such as "note" and "warning" will accept content
immediately following the directive, this is technically where arguments
to the
directive should go (see http://sphinx.pocoo.org/rest.html#directives).
Putting
the content there means that any lines beginning with an inline text role
(e.g. ":setting:`DEBUG`") will be mis-interpreted as an option block for
the
directive. To avoid this error, there should always be a blank line
between the
directive start and the directive content.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/16863#comment:1>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/django-updates?hl=en.
