<commit_before>=====
docfu
=====

docfu makes generating documentation from a git repository easy. You might find it useful if you have a git repository
and would like to generate documentation on a per-branch or -tag basis.

Usage:

    docfu  --sub-dir "docs/src" "feltnerm/docfu" "/home/feltnerm/public_html/docs"

or

    docfu  --tag "0.1" --sub-dir "docs/src" "feltnerm/docfu" "/home/feltnerm/public_html/docs"

or

    docfu  --branch "develop" --sub-dir "docs/src" "feltnerm/docfu" "/home/feltnerm/public_html/docs"
<commit_msg>doc(README.rst): Better formatting<commit_after>=====
docfu
=====

docfu makes generating documentation from a git repository easy. You might find it useful if you have a git repository
and would like to generate documentation on a per-branch or -tag basis.

Usage: 
------

::

    docfu [-h] [-b BRANCH] [-t TAG] [-s SUB_DIR] uri destination

    positional arguments:
    uri                   A URI pointing to a file path, git repository, or
                          github shortened repo.
    destination           Destination for compiled source.

    optional arguments:
      -h, --help            show this help message and exit
      -b BRANCH, --branch BRANCH
                            A git branch to checkout.
      -t TAG, --tag TAG     A git tag to checkout.
      -s SUB_DIR, --sub-dir SUB_DIR
                            Sub-directory which to compile from.
                            
Examples:
---------

Specify a sub-directory:
~~~~~~~~~~~~~~~~~~~~~~~
``docfu  --sub-dir "docs/src" "feltnerm/docfu" "/home/feltnerm/public_html/docs"``

Docfu a specific tag
~~~~~~~~~~~~~~~~~~~~~~~
``docfu  --tag "0.1" --sub-dir "docs/src" "feltnerm/docfu" "/home/feltnerm/public_html/docs"``

Docfu a specific branch
~~~~~~~~~~~~~~~~~~~~~~~
``docfu  --branch "develop" --sub-dir "docs/src" "feltnerm/docfu" "/home/feltnerm/public_html/docs"``

{'fraction_non_alphanumeric': 0.1524616199047115, 'fraction_numerical': 0.0021175224986765486, 'mean_word_length': 2.4615384615384617, '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': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1108225', 'n_tokens_mistral': 607, 'n_tokens_neox': 567, 'n_words': 192}