#16863 closed Cleanup/optimization (fixed)
Multiple "invalid option block" errors when building docs
Reported by: | Carl Meyer | Owned by: | nobody |
---|---|---|---|
Component: | Documentation | Version: | dev |
Severity: | Normal | Keywords: | |
Cc: | Triage Stage: | Unreviewed | |
Has patch: | no | Needs documentation: | no |
Needs tests: | no | Patch needs improvement: | no |
Easy pickings: | no | UI/UX: | no |
Description
Using Sphinx 1.07, I get 8 errors like this on a fresh docs build:
/home/carljm/projects/django/django/django-git/docs/topics/i18n/localization.txt:262: (ERROR/3) Error in "note" directive: invalid option block. .. note:: The default :file:`settings.py` file created by :djadmin:`django-admin.py startproject <startproject>` includes :setting:`USE_L10N = True <USE_L10N>` for convenience.
I think it's from lines beginning with a colon inside a directive (usually .. note
or .. warning
), which Sphinx is trying to interpret as option blocks for that directive.
If there's a way we could just turn that error off, that'd be nice. Otherwise we should probably fix these cases manually and try to avoid introducing new ones, it's a barrier to new docs contributors to have a bunch of "known errors" in the docs build.
Note:
See TracTickets
for help on using tickets.
In [16842]:
(The changeset message doesn't reference this ticket)