tweaks.param_dash

Monkeypatches sphinx.util.docfields.TypedField to only output the endash (–) separating the parameter name from its description if a description was given.

New in version 0.9.0.

Example

.. class:: MyClass(foo, bar)

    This is my class.

    :param foo: An argument
    :param bar:
class MyClass(foo, bar)

This is my class.

Parameters:

  • foo – An argument

  • bar

Enable sphinx_toolbox.tweaks.param_dash by adding the following to the extensions variable in your conf.py:

extensions = [
    ...
    'sphinx_toolbox.tweaks.param_dash',
    ]

For more information see https://www.sphinx-doc.org/en/master/usage/extensions#third-party-extensions .

setup(app)[source]

Setup sphinx_toolbox.tweaks.param_dash.

Parameters:

app (Sphinx) – The Sphinx application.

Return type:

SphinxExtMetadata