<commit_before>==================================
Building documentation for nmrglue
==================================

nmrglue uses Sphinx for building it's documentation.  Sphinx version 1.1.3 has
been tested, earlier and later version may work.

Instructions
------------

1. Run ``make html``.

The html documentation should be stored in the build/html directory.  


Upload to gh-pages
------------------

On my machine to publish the newly build documentation to github run the
following:

rm -r ../../nmrglue_gh-pages/*
cp -r build/html/* ../../nmrglue_gh-pages/
cd ../../nmrglue_gh-pages
git add *
git commit -am "Updated documentation<commit_msg>update doc/README.txt<commit_after>==================================
Building documentation for nmrglue
==================================

nmrglue uses Sphinx for building it's documentation.  Sphinx version 2.1.0 has
been tested, earlier and later version may work.

Instructions
------------

1.  Create and activate a environment with nmrglue dependencies, sphinx,
    numpydoc and sphinx_rtd_theme installed.  For example using conda:

        conda create -n nmrglue_dev_38 python=3.8 numpy scipy pytest sphinx pip numpydoc sphinx_rtd_theme -c conda-forge
        conda activate nmrglue_dev_38

2.  Install nmrglue in editable mode using the following from the root
    directory.

    pip install -e .

3.  Run ``make html``. in this directory.

The html documentation should be stored in the build/html directory.  


ReadTheDocs
-----------

The documentation is automatically built for each commit by ReadTheDocs and
published to https://nmrglue.readthedocs.io
{'fraction_non_alphanumeric': 0.17148125384142593, 'fraction_numerical': 0.009834050399508297, 'mean_word_length': 3.522222222222222, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 1, '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': '3164921', 'n_tokens_mistral': 480, 'n_tokens_neox': 443, 'n_words': 180}