<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to Flask-Avatar’s documentation! — Flask-Avatar 0.1.0 documentation</title>
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '0.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Flask-Avatar 0.1.0 documentation" href="#" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head>
<body role="document">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="welcome-to-flask-avatar-s-documentation">
<h1>Welcome to Flask-Avatar’s documentation!<a class="headerlink" href="#welcome-to-flask-avatar-s-documentation" title="Permalink to this headline">¶</a></h1>
<p>It’s easy to generate avatar for flask.</p>
<div class="section" id="installation">
<h2>1.1 Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
<p>To install Flask-Avatar:</p>
<div class="highlight-shell"><div class="highlight"><pre><span></span>pip install flask-avatar
</pre></div>
</div>
<p>Or alternatively, you can download the repository and install manually by doing:</p>
<div class="highlight-sehll"><div class="highlight"><pre><span></span>git clone git@github.com:honmaple/flask-avatar.git
cd flask-avatar
python setup.py install
</pre></div>
</div>
</div>
<div class="section" id="usage">
<h2>1.2 Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">flask_avatar</span> <span class="kn">import</span> <span class="n">Avatar</span>
<span class="p">[</span><span class="o">...</span><span class="p">]</span>
<span class="n">Avatar</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
</pre></div>
</div>
<p>Templates:</p>
<div class="highlight-html"><div class="highlight"><pre><span></span>{{ url_for('avatar',text = user.username )}}
</pre></div>
</div>
</div>
<div class="section" id="config">
<h2>1.3 Config<a class="headerlink" href="#config" title="Permalink to this headline">¶</a></h2>
<p>AVATAR_URL = “The avatar url,default ‘avatar’”</p>
<div class="toctree-wrapper compound">
<ul class="simple">
</ul>
</div>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Welcome to Flask-Avatar’s documentation!</a><ul>
<li><a class="reference internal" href="#installation">1.1 Installation</a></li>
<li><a class="reference internal" href="#usage">1.2 Usage</a></li>
<li><a class="reference internal" href="#config">1.3 Config</a></li>
</ul>
</li>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©2016, honmaple.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.1</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
<a href="_sources/index.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>