<commit_before>====
Doc8
====

Doc8 is a *opinionated* style checker for `rst`_ (with basic support for
plain text) styles of documentation.

Features
--------

* Ability to parse and validate rst files.

QuickStart
==========

::

    pip install doc8

To run doc8 just invoke it against any doc directory::

    $ doc8 coolproject/docs

Usage
=====

Command line usage
******************
<commit_msg>Just remove the features sub-section<commit_after>====
Doc8
====

Doc8 is a *opinionated* style checker for `rst`_ (with basic support for
plain text) styles of documentation.

QuickStart
==========

::

    pip install doc8

To run doc8 just invoke it against any doc directory::

    $ doc8 coolproject/docs

Usage
=====

Command line usage
******************

{'fraction_non_alphanumeric': 0.16361256544502617, 'fraction_numerical': 0.013089005235602094, 'mean_word_length': 4.0, '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': '5338439', 'n_tokens_mistral': 233, 'n_tokens_neox': 218, 'n_words': 90}