.. _f-sphinxdocassertextension:

module ``sphinxext.sphinx_docassert_extension``
===============================================





.. inheritance-diagram:: pyquickhelper.sphinxext.sphinx_docassert_extension


Short summary
+++++++++++++

module ``pyquickhelper.sphinxext.sphinx_docassert_extension``

Defines a :epkg:`sphinx` extension which if all parameters are documented.


:githublink:`%|py|6`




Classes
+++++++

+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+
| class                                                                                                                 | truncated documentation                              |
+=======================================================================================================================+======================================================+
| :class:`OverrideDocFieldTransformer <pyquickhelper.sphinxext.sphinx_docassert_extension.OverrideDocFieldTransformer>` | Overrides one function with assigning it to a method |
+-----------------------------------------------------------------------------------------------------------------------+------------------------------------------------------+




Functions
+++++++++

+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| function                                                                                                   | truncated documentation                                                                                                  |
+============================================================================================================+==========================================================================================================================+
| :func:`check_typed_make_field <pyquickhelper.sphinxext.sphinx_docassert_extension.check_typed_make_field>` | Overwrites function #L197>`_. `make_field <https://github.com/sphinx-doc/sphinx/blob/master/sphinx/util/docfields.py ... |
+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :func:`setup <pyquickhelper.sphinxext.sphinx_docassert_extension.setup>`                                   | setup for docassert                                                                                                      |
+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| :func:`setup_docassert <pyquickhelper.sphinxext.sphinx_docassert_extension.setup_docassert>`               | Setup for ``docassert`` extension (sphinx). This changes ``DocFieldTransformer.transform`` and replaces it by a ...      |
+------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------+








Methods
+++++++

+--------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| method                                                                                                                         | truncated documentation                                                                                                                                      |
+================================================================================================================================+==============================================================================================================================================================+
| :py:meth:`__init__ <pyquickhelper.sphinxext.sphinx_docassert_extension.OverrideDocFieldTransformer.__init__>`                  | Constructor                                                                                                                                                  |
+--------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :meth:`override_transform <pyquickhelper.sphinxext.sphinx_docassert_extension.OverrideDocFieldTransformer.override_transform>` | Transform a single field list *node*. Overwrite function `transform <https://github.com/sphinx-doc/sphinx/blob/ master/sphinx/util/docfields.py#L271>`_. ... |
+--------------------------------------------------------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+


Documentation
+++++++++++++

.. automodule:: pyquickhelper.sphinxext.sphinx_docassert_extension
    :members:
    :special-members: __init__
    :show-inheritance: