<commit_before># About

Docrepr is a library to render Python docstrings as html pages. It is based on
the `sphinxify` module developed by <NAME> for the Sage Notebook and the
`utils.inspector` one developed for Spyder.

# Details

The module renders dictionary as returned by IPython `oinspect` and exports
two functions - **sphinxify** which uses Sphinx to render docstrings, and
**rich_repr** that generates full HTML page with all assets from
`IPython.core.oinspect` output and returns URL to it. 

# License

This project is distributed under the under the terms of the Modified BSD
License<commit_msg>Add API usage example to README.md<commit_after># About

Docrepr is a library to render Python docstrings as html pages. It is based on
the `sphinxify` module developed by <NAME> for the Sage Notebook and the
`utils.inspector` one developed for Spyder.

# Details

The module renders dictionary as returned by IPython `oinspect` and exports
two functions - **sphinxify** which uses Sphinx to render docstrings, and
**rich_repr** that generates full HTML page (with all assets) from
`IPython.core.oinspect` output and returns URL to it.

Example:

    >>> import docrepr, IPython
    >>> myset = set()
    >>> oinfo = IPython.core.oinspect.Inspector().info(myset, oname='myset')
    >>> docrepr.sphinxify.rich_repr(oinfo)
    c:\users\user\appdata\local\temp\docrepr\tmpwvoj3s\rich_repr_output.html

# License

This project is distributed under the under the terms of the Modified BSD
License
{'fraction_non_alphanumeric': 0.07409879839786382, 'fraction_numerical': 0.0006675567423230974, 'mean_word_length': 4.635338345864661, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 17, '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': '6214660', 'n_tokens_mistral': 459, 'n_tokens_neox': 449, 'n_words': 191}