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

Comments

comments powered by Disqus