Added example with custom template

Arnaud Coomans · Arnaud Coomans · commit 95bf2b37c7ec · 2015-09-03T10:08:05.000-07:00
diff --git a/examples/custom/blog.py b/examples/custom/blog.py
@@ -0,0 +1,115 @@
+from os import path
+from json import dumps
+
+from flask import Flask, redirect, request
+from flask.ext.autodoc import Autodoc
+
+
+app = Flask(__name__)
+app.debug = True
+auto = Autodoc(app)
+
+users = []
+posts = []
+
+
+class User(object):
+
+    def __init__(self, username):
+        self.username = username
+        users.append(self)
+        self.id = users.index(self)
+
+    def __repr__(self):
+        return dumps(self.__dict__)
+
+
+class Post(object):
+
+    def __init__(self, title, content, author):
+        self.title = title
+        self.content = content
+        posts.append(self)
+        self.id = posts.index(self)
+
+    def __repr__(self):
+        return dumps(self.__dict__)
+
+
+u = User('acoomans')
+Post('First post', 'This is the first awesome post', u)
+Post('Second post', 'This is another even more awesome post', u)
+
+
+@app.route('/')
+@app.route('/posts')
+@auto.doc(groups=['posts', 'public', 'private'])
+def get_posts():
+    """Return all posts."""
+    return '%s' % posts
+
+
+@app.route('/post/<int:id>')
+@auto.doc(groups=['posts', 'public', 'private'])
+def get_post(id):
+    """Return the post for the given id."""
+    return '%s' % posts[id]
+
+
+@app.route('/post', methods=["POST"])
+@auto.doc(groups=['posts', 'private'])
+def post_post():
+    """Create a new post.
+    Form Data: title, content, authorid.
+    """
+    authorid = request.form.get('authorid', None)
+    Post(request.form['title'],
+         request.form['content'],
+         users[authorid])
+    return redirect("/posts")
+
+
+@app.route('/users')
+@auto.doc(groups=['users', 'public', 'private'])
+def get_users():
+    """Return all users."""
+    return '%s' % users
+
+
+@app.route('/user/<int:id>')
+@auto.doc(groups=['users', 'public', 'private'])
+def get_user(id):
+    """Return the user for the given id."""
+    return '%s' % users[id]
+
+
+@app.route('/users', methods=['POST'])
+@auto.doc(groups=['users', 'private'])
+def post_user(id):
+    """Creates a new user.
+    Form Data: username.
+    """
+    User(request.form['username'])
+    redirect('/users')
+
+
+@app.route('/admin', methods=['GET'])
+@auto.doc(groups=['private'])
+def admin():
+    """Admin interface."""
+    return 'Admin interface'
+
+
+@app.route('/doc/')
+@app.route('/doc/public')
+def public_doc():
+    return auto.html(groups=['public'], title='Blog Documentation with Custom template', template="autodoc_custom.html")
+
+
+@app.route('/doc/private')
+def private_doc():
+    return auto.html(groups=['private'], title='Private Documentation with Custom template', template="autodoc_custom.html")
+
+
+if __name__ == '__main__':
+    app.run()
diff --git a/examples/custom/templates/autodoc_custom.html b/examples/custom/templates/autodoc_custom.html
@@ -0,0 +1,79 @@
+<html>
+    <head>
+        <title>
+            {% if title is defined -%}
+                {{title}}
+            {% else -%}
+                Documentation
+            {% endif -%}
+        </title>
+        <style>
+            * {
+                margin: 0;
+                padding: 0;
+                font-family: Verdana, "Helvetica Neue", Arial, Helvetica, Geneva, sans-serif;
+            }
+
+            body {
+                margin: 10px;
+            }
+
+            div.mapping {
+                margin: 20px 20px;
+            }
+
+            .location { font-style: italic;}
+
+            ul.methods:before { content: "Methods: "; }
+            ul.methods li {
+                display: inline;
+                list-style: none;
+            }
+            ul.methods li:after { content: ","; }
+            ul.methods li:last-child:after { content: ""; }
+
+            ul.arguments:before { content: "Arguments: "; }
+            ul.arguments li {
+                display: inline;
+                list-style: none;
+            }
+            ul.arguments .argument { font-style:italic }
+            ul.arguments .default:not(:empty):before { content: "("; }
+            ul.arguments .default:not(:empty):after { content: ")"; }
+            ul.arguments li:after { content: ","; }
+            ul.arguments li:last-child:after { content: ""; }
+
+            .docstring:before { content: "Description: "; }
+        </style>
+    </head>
+    <body>
+        <h1>
+            {% if title is defined -%}
+                {{title}}
+            {% else -%}
+                Documentation
+            {% endif -%}
+        </h1>
+
+        {% for doc in autodoc %}
+        <div class="mapping">
+            <a id="rule-{{doc.rule|urlencode}}" class="rule"><h2>{{doc.rule|escape}}</h2></a>
+            <p class="location">{{doc.location.filename}}:{{doc.location.line}}</p>
+            <ul class="methods">
+                    {% for method in doc.methods -%}
+                    <li class="method">{{method}}</li>
+                    {% endfor %}
+            </ul>
+            <ul class="arguments">
+                {% for arg in doc.args %}
+                <li>
+                    <span class="argument">{{arg}}</span>
+                    <span class="default">{{doc.defaults[arg]}}</span>
+                </li>
+                {% endfor %}
+            </ul>
+            <p class="docstring">{{doc.docstring|urlize|nl2br}}</p>
+        </div>
+        {% endfor %}
+    </body>
+</html>
