<commit_before>.. _ref-autodoc:

Autodoc
=======
See the `Sphinx autodoc`_ page for full documentation.

.. _Sphinx autodoc: http://sphinx-doc.org/ext/autodoc.html#module-sphinx.ext.autodoc

Functions
---------
To document the function ``mymodule.power``::

    .. autofunction:: mymodule.power

Classes
-------
To automatically document classes::

    .. autoclass:: my_module.MyClass
        :members:
        :undoc-members:

* The ``:members:`` option will automatically generate all documented methods
* The ``:undoc-members:`` option will document all undocumented methods
* The ``:private-members:`` option will document private options (methods that
    start with one or two underscores. Ex: ``_private``)

Modules
-------
To document your module::

    .. automodule:: mymodule
<commit_msg>fixed indentation<commit_after>.. _ref-autodoc:

Autodoc
=======
See the `Sphinx autodoc`_ page for full documentation.

.. _Sphinx autodoc: http://sphinx-doc.org/ext/autodoc.html#module-sphinx.ext.autodoc

Functions
---------
To document the function ``mymodule.power``::

    .. autofunction:: mymodule.power

Classes
-------
To automatically document classes::

    .. autoclass:: my_module.MyClass
        :members:
        :undoc-members:

* The ``:members:`` option will automatically generate all documented methods
* The ``:undoc-members:`` option will document all undocumented methods
* The ``:private-members:`` option will document private options (methods that
        start with one or two underscores. Ex: ``_private``)

Modules
-------
To document your module::

    .. automodule:: mymodule

{'fraction_non_alphanumeric': 0.14427860696517414, 'fraction_numerical': 0.0, 'mean_word_length': 3.494413407821229, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4500301', 'n_tokens_mistral': 489, 'n_tokens_neox': 474, 'n_words': 145}