Sphinx Errors

List of common Sphinx, Docutils and reStructuredText warnings and errors. Each issue is well explained, illustrated by an example, and offers solution.

• Sphinx error: Document isn’t included in any toctree
• Sphinx error: The … directive is empty; content required
• Sphinx error: 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 …)
• Sphinx error: Duplicate target name, cannot be used as a unique reference
• Sphinx error: Error in “xyz” directive: no content permitted
• Sphinx error: Image file not readable
• Sphinx error: Inline literal start-string without end-string
• Sphinx error: “list-table” widths do not match the number of columns in table
• Sphinx error: Recursion error: maximum recursion depth exceeded in comparison
• Sphinx error: Undefined label: … (if the link has no caption the label must precede a section header)
• Sphinx error: Literal block expected; none found