<commit_before>Travis docs builder
===================

A tool for automatically building Sphinx docs on Travis CI, and deploying them
to GitHub pages.

This tool is still a work in progress, but once it works it's going to be
awesome.

Installation
------------

Install doctr with pip

.. code::

   pip install doctr

or conda

.. code::

   conda install -c conda-forge doctr

**Note that doctr requires Python 3.5.**

Usage
-----

Run

.. code::
<commit_msg>Doctr does work now<commit_after>Travis docs builder
===================

A tool for automatically building Sphinx docs on Travis CI, and deploying them
to GitHub pages.

Installation
------------

Install doctr with pip

.. code::

   pip install doctr

or conda

.. code::

   conda install -c conda-forge doctr

**Note that doctr requires Python 3.5.**

Usage
-----

Run

.. code::

{'fraction_non_alphanumeric': 0.1474056603773585, 'fraction_numerical': 0.0047169811320754715, 'mean_word_length': 2.912442396313364, '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': '7072495', 'n_tokens_mistral': 274, 'n_tokens_neox': 245, 'n_words': 110}