Documenting with Sphinx python methods that do have default parameters with sentinel objects?

Question

If you want to be able to allow people to call some methods using None you have to do use a sentinel object when you define the method.

 _senti         


        

Answer 1

This can be handled by manually specifying function signature in autodoc directive, e.g.:

.. automodule:: pymorphy.contrib.tokenizers

    .. autofunction:: extract_tokens(foo, bar)

    .. autofunction:: extract_words