Sphinx Errors#
List of common Sphinx, Docutils and reStructuredText warnings and errors. Each issue is well explained, illustrated by an example, and offers solution.
- Document isn’t included in any toctree
- The … directive is empty; content required
- Error parsing content block for the “list-table” directive: uniform …-level bullet list expected, but row … does not contain the same number of items as row … (… vs …)
- Duplicate target name, cannot be used as a unique reference
- Error in “xyz” directive: no content permitted
- Image file not readable
- Inline literal start-string without end-string
- “list-table” widths do not match the number of columns in table
- Recursion error: maximum recursion depth exceeded in comparison
- Undefined label: … (if the link has no caption the label must precede a section header)
- Literal block expected; none found
Comments
comments powered by Disqus