<commit_before>Flask-Autodoc
=============

Flask Autodoc is a Flask extension that automatically creates documentation for your endpoints based on the routes,
function arguments and docstring.

## Install

To install Flask-Autodoc:

    python setup.py install

## Usage

Start using Flask-Autodoc by importing it and initializing it:

    from flask import Flask
    from flask.ext.autodoc import Autodoc
    
    app = Flask(__name__)
    auto = Autodoc(app)

by default, Flask-Autodoc will only document the routes you explicitly tell him to with the _doc_ decorator,
like this:
  
    @app.route('/user/<int:id>')
    @auto.doc
    def show_user(id):
        """This returns a user with a given id."""
        return user_from_database(id)

to generate the documentation from an endpoint, use the _html()_ method:

    @app.route('/documentation')
    def documentation():
        return auto.html()

if you to access the documentation without it being rendered in html:

    @app.route('/documentation')
    def documentation():
        return auto.generate()
<commit_msg>Fixes #4 - @auto.doc needs to be a function @auto.doc()<commit_after>Flask-Autodoc
=============

Flask Autodoc is a Flask extension that automatically creates documentation for your endpoints based on the routes,
function arguments and docstring.

## Install

To install Flask-Autodoc:

    python setup.py install

## Usage

Start using Flask-Autodoc by importing it and initializing it:

    from flask import Flask
    from flask.ext.autodoc import Autodoc

    app = Flask(__name__)
    auto = Autodoc(app)

by default, Flask-Autodoc will only document the routes you explicitly tell him to with the _doc_ decorator,
like this:

    @app.route('/user/<int:id>')
    @auto.doc()
    def show_user(id):
        """This returns a user with a given id."""
        return user_from_database(id)

to generate the documentation from an endpoint, use the _html()_ method:

    @app.route('/documentation')
    def documentation():
        return auto.html()

if you to access the documentation without it being rendered in html:

    @app.route('/documentation')
    def documentation():
        return auto.generate()

{'fraction_non_alphanumeric': 0.09206927985414767, 'fraction_numerical': 0.00045578851412944393, 'mean_word_length': 3.488752556237219, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, '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': '7090526', 'n_tokens_mistral': 636, 'n_tokens_neox': 609, 'n_words': 242}