<commit_before>.. image:: https://cloud.githubusercontent.com/assets/5716520/24838296/a9cf5f04-1d45-11e7-855c-47b816ce1e09.png
    :target: https://coala.io/

The official documentation for coala
====================================

This is the official documentation for coala, and it is online at https://docs.coala.io.
The coala repository can be found
`here <https://github.com/coala/coala>`__.

How to build
============

You should run this command before trying to build the documentation:

::

    pip3 install -r requirements.txt

You can test the documentation locally through simply running

::

    make html

in the root directory. This generates ``_build/html/index.html`` that you can
view on your browser.

If you want to add new pages, you need to alter the index.rst file in the root
directory. Please read
http://www.sphinx-doc.org/en/stable/markup/toctree.html#toctree-directive for
an explanation of the syntax.<commit_msg>README.rst: Update build instructions<commit_after>.. image:: https://cloud.githubusercontent.com/assets/5716520/24838296/a9cf5f04-1d45-11e7-855c-47b816ce1e09.png
    :target: https://coala.io/

The official documentation for coala
====================================

This is the official documentation for coala, and it is online at https://docs.coala.io.
The coala repository can be found
`here <https://github.com/coala/coala>`__.

How to build
============

Install ``virtualenv`` if you don't have it yet:

::

    pip3 install virtualenvwrapper

Create a new ``virtualenv`` and activate it:

::

    virtualenv -p python3 coala-venv
    source coala-venv/bin/activate

And then run this command before trying to build the documentation:

::

    pip3 install -r requirements.txt

You can test the documentation locally through simply running

::

    make html

in the root directory. This generates ``_build/html/index.html`` that you can
view on your browser.

If you want to add new pages, you need to alter the index.rst file in the root
directory. Please read
http://www.sphinx-doc.org/en/stable/markup/toctree.html#toctree-directive for
an explanation of the syntax.
{'fraction_non_alphanumeric': 0.12988235294117648, 'fraction_numerical': 0.03576470588235294, 'mean_word_length': 4.185365853658537, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 8, 'lorem ipsum': 0, 'www.': 2, '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': '6902090', 'n_tokens_mistral': 680, 'n_tokens_neox': 629, 'n_words': 228}