This Sphinx extension should be used in conjunction with the Autodoc extension. This extension allows docstrings (module, class, function, etc) to include ReST-style section headers (which normally cause problems if integrated into Sphinx documentation via Autodoc).
This extension detects all single-line (but not double-line) headers, and turns them into a series of definition lists (<dl>), with the header name as the term (<dt>), and the section’s content as the definition (<dd>).
In order for Sphinx themes (like “Cloud” sphinx theme) to distinguish these from regular definition lists, the <dl> elements generated by this extension are assigned the css classes nested-section and nested-section-level.
This extension is currently somewhat fragile: it works reliably for the common cases, but may not behave properly given unexpected input.
This extension has a number of things which could be improved: