Raise an error with a useful message if the app is not set up.

.travis.yml

@@ -3,7 +3,13 @@ python:
   - "2.7"
   - "3.3"
   - "3.4"
+  - "3.5"
+env:
+  - FLASK=0.12
+  - FLASK=1.0
+  - FLASK=1.0.2
 install: 
-  - pip install -r requirements.txt
+  - pip install Flask==${FLASK}
 script: 
   - python -m unittest discover
+

MANIFEST.in

@@ -1,2 +1,2 @@
 include README.md
-include flask_autodoc/templates/autodoc_default.html
+include flask_selfdoc/templates/autodoc_default.html

README.md

@@ -1,40 +1,40 @@
-Flask-Autodoc
+Flask-Selfdoc
 =============
 
-Flask-Autodoc is a Flask extension that automatically creates documentation for your endpoints based on the routes, function arguments and docstrings.
+Flask-Selfdoc is a Flask extension that automatically creates documentation for your endpoints based on the routes, function arguments and docstrings. It was forked from Flask-Autodoc, written by Arnaud Coomans, and is completely compatible as a replacement for that extension.
 
-[![Build](https://api.travis-ci.org/acoomans/flask-autodoc.png)](https://travis-ci.org/acoomans/flask-autodoc)
-[![Pypi version](http://img.shields.io/pypi/v/flask-autodoc.svg)](https://pypi.python.org/pypi/Flask-Autodoc)
-[![Pypi license](http://img.shields.io/pypi/l/flask-autodoc.svg)](https://pypi.python.org/pypi/Flask-Autodoc)
+[![Build](https://api.travis-ci.org/jwg4/flask-autodoc.png)](https://travis-ci.org/jwg4/flask-autodoc)
+[![Pypi version](http://img.shields.io/pypi/v/flask-autodoc.svg)](https://pypi.python.org/pypi/Flask-Selfdoc)
+[![Pypi license](http://img.shields.io/pypi/l/flask-selfdoc.svg)](https://pypi.python.org/pypi/Flask-Selfdoc)
 ![Python 2](http://img.shields.io/badge/python-2-blue.svg)
 ![Python 3](http://img.shields.io/badge/python-3-blue.svg)
 
 
 ## Requirements
 
-Flask-Autodoc is compatible with Python versions 2 and 3; and it depends only on Flask.
+Flask-Selfdoc is compatible with Python versions 2 and 3; and it depends only on Flask.
 
 ## Install
 
-To install Flask-Autodoc, run pip:
+To install Flask-Selfdoc, run pip:
 
-	pip install flask-autodoc
+	pip install flask-selfdoc
 
 or clone this directory and run setup:
 
     python setup.py install
 
 ## Usage
 
-Start using Flask-Autodoc by importing it and initializing it:
+Start using Flask-Selfdoc by importing it and initializing it:
 
     from flask import Flask
-    from flask.ext.autodoc import Autodoc
+    from flask.ext.selfdoc import Autodoc
 
     app = Flask(__name__)
     auto = Autodoc(app)
 
-by default, Flask-Autodoc will only document the routes explicitly decorated with _doc_:
+by default, Flask-Selfdoc will only document the routes explicitly decorated with _doc_:
 
     @app.route('/user/<int:id>')
     @auto.doc()

examples/custom/blog.py

@@ -2,7 +2,7 @@
 from json import dumps
 
 from flask import Flask, redirect, request
-from flask.ext.autodoc import Autodoc
+from flask_selfdoc import Autodoc
 
 
 app = Flask(__name__)

examples/factory/blog/doc.py

@@ -1,5 +1,5 @@
 from flask import Blueprint
-from flask.ext.autodoc import Autodoc
+from flask_selfdoc import Autodoc
 
 
 doc = Blueprint('doc', __name__, url_prefix='/doc')

examples/simple/blog.py

@@ -1,7 +1,7 @@
 from json import dumps
 
 from flask import Flask, redirect, request
-from flask.ext.autodoc import Autodoc
+from flask_selfdoc import Autodoc
 
 
 app = Flask(__name__)

flask_selfdoc/__init__.py

@@ -0,0 +1,3 @@
+__author__ = 'arnaud'
+
+from flask_selfdoc.autodoc import Autodoc

flask_autodoc/autodoc.py → flask_selfdoc/autodoc.py

@@ -176,6 +176,8 @@ def html(self, groups='all', template=None, **context):
         By specifying the group or groups arguments, only routes belonging to
         those groups will be returned.
         """
+        if not self.app:
+            raise RuntimeError("Autodoc was not initialized with the Flask app.")
         context['autodoc'] = context['autodoc'] if 'autodoc' in context \
             else self.generate(groups=groups)
         context['defaults'] = context['defaults'] if 'defaults' in context \

setup.py

@@ -1,8 +1,8 @@
 """
-Flask-Autodoc
+Flask-Selfdoc
 -------------
 
-Flask autodoc automatically creates an online documentation for your flask app.
+Flask selfdoc automatically creates an online documentation for your flask app.
 """
 from setuptools import setup
 
@@ -13,19 +13,18 @@ def readme():
 
 
 setup(
-    name='Flask-Autodoc',
-    version='0.1.2',
-    url='http://github.com/acoomans/flask-autodoc',
+    name='Flask-Selfdoc',
+    version='0.2',
+    url='http://github.com/jwg4/flask-selfdoc',
     license='MIT',
     author='Arnaud Coomans',
-    author_email='[email protected]',
     description='Documentation generator for flask',
     long_description=readme(),
     # py_modules=['flask_autodoc'],
     # if you would be using a package instead use packages instead
     # of py_modules:
-    packages=['flask_autodoc'],
-    package_data={'flask_autodoc': ['templates/autodoc_default.html']},
+    packages=['flask_selfdoc'],
+    package_data={'flask_selfdoc': ['templates/autodoc_default.html']},
     zip_safe=False,
     include_package_data=True,
     platforms='any',
@@ -41,5 +40,5 @@ def readme():
         'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
         'Topic :: Software Development :: Libraries :: Python Modules'
     ],
-    test_suite='tests.test_autodoc',
+    test_suite='tests',
 )

tests/test_autodoc.py

@@ -5,7 +5,7 @@
 import os
 
 from flask import Flask
-from flask.ext.autodoc import Autodoc
+from flask_selfdoc import Autodoc
 
 
 class TestAutodoc(unittest.TestCase):

tests/test_error_handling.py

@@ -0,0 +1,13 @@
+import unittest
+
+from flask import Flask
+from flask_selfdoc import Autodoc
+
+
+class TestErrorHandling(unittest.TestCase):
+    def test_app_not_initialized(self):
+        app = Flask(__name__)
+        app.debug = True
+        autodoc = Autodoc()
+        with app.app_context():
+            self.assertRaises(RuntimeError, lambda: autodoc.html())