<commit_before>Sphinx epytext support
======================

sphinx-epytext provides basic support for epytext docstrings
<http://epydoc.sourceforge.net/epytext.html> 
in Sphinx autodoc <http://sphinx-doc.org/ext/autodoc.html>. 

It connects to the 'autodoc-process-docstring' hook of Sphinx, to perform the following:

- Replaces '@' in docstrings with ':' for epydoc fields. <http://epydoc.sourceforge.net/fields.html>
- Replaces L{..} and C{..} with :py:obj:`..`
- Removes U{..} from around links

To use it, add 'sphinx_epytext' to 'extensions' in your Sphinx conf.py and run sphinx-build.<commit_msg>more clear configuration information<commit_after>Sphinx epytext support
======================

sphinx-epytext provides basic support for epytext docstrings
<http://epydoc.sourceforge.net/epytext.html> 
in Sphinx autodoc <http://sphinx-doc.org/ext/autodoc.html>. 

It connects to the 'autodoc-process-docstring' hook of Sphinx, to perform the following:

- Replaces '@' in docstrings with ':' for epydoc fields. <http://epydoc.sourceforge.net/fields.html>
- Replaces L{..} and C{..} with :py:obj:`..`
- Removes U{..} from around links

Configuration
-------------

Add it to your extensions in ``conf.py``::

    extensions = [
        'sphinx.ext.autodoc',
        'sphinx_epytext',
        # your other sphinx extensions
        # ...
    ]

Then run ``sphinx-build``.
{'fraction_non_alphanumeric': 0.16702977487291212, 'fraction_numerical': 0.0, 'mean_word_length': 3.687074829931973, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, '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': '6733587', 'n_tokens_mistral': 484, 'n_tokens_neox': 462, 'n_words': 126}