TechWriter at work blog

Living and writing documentation at Documatt, small team of programmers that write documentation too.

---

The … directive is empty; content required

Symptoms

Sphinx build failed with the error similar to:

WARNING: The "list-table" directive is empty; content required.

Reasons

Directive is an block that does something special with a passed text. May directives require content, e.g. list-table::, or topic::. The warning above means you forgot the directive content or isn’t properly indented.

Example

.. topic:: Topic Title

Subsequent indented lines comprise
the body of the topic, and are
interpreted as body elements.

Solution

Directive content needs to be properly indented at the column where directive name starts (here at the column 3):

.. topic:: Topic Title

   Subsequent indented lines comprise
   the body of the topic, and are
   interpreted as body elements.