scverse_doc.typed_fields#

Parameters and attributes as definition lists.

Sphinx renders typed fields (:param: with :type:, :var: with :vartype:, …) as a list of paragraphs, cramming name, type, and description into one line. This extension renders them as definition lists instead, like numpydoc:

.. py:function:: test(a)

   :param a: Only parameter
   :type a: str

renders the term a classified as str, with the description indented below it.