index.html 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>Welcome to Flask-Avatar’s documentation! &mdash; Flask-Avatar 0.1.0 documentation</title>
  7. <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
  8. <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: './',
  12. VERSION: '0.1.0',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="_static/jquery.js"></script>
  19. <script type="text/javascript" src="_static/underscore.js"></script>
  20. <script type="text/javascript" src="_static/doctools.js"></script>
  21. <link rel="top" title="Flask-Avatar 0.1.0 documentation" href="#" />
  22. <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  23. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  24. </head>
  25. <body role="document">
  26. <div class="document">
  27. <div class="documentwrapper">
  28. <div class="bodywrapper">
  29. <div class="body" role="main">
  30. <div class="section" id="welcome-to-flask-avatar-s-documentation">
  31. <h1>Welcome to Flask-Avatar&#8217;s documentation!<a class="headerlink" href="#welcome-to-flask-avatar-s-documentation" title="Permalink to this headline">¶</a></h1>
  32. <p>It&#8217;s easy to generate avatar for flask.</p>
  33. <div class="section" id="installation">
  34. <h2>1.1 Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
  35. <p>To install Flask-Avatar:</p>
  36. <div class="highlight-shell"><div class="highlight"><pre><span></span>pip install flask-avatar
  37. </pre></div>
  38. </div>
  39. <p>Or alternatively, you can download the repository and install manually by doing:</p>
  40. <div class="highlight-sehll"><div class="highlight"><pre><span></span>git clone git@github.com:honmaple/flask-avatar.git
  41. cd flask-avatar
  42. python setup.py install
  43. </pre></div>
  44. </div>
  45. </div>
  46. <div class="section" id="usage">
  47. <h2>1.2 Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
  48. <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>
  49. <span class="p">[</span><span class="o">...</span><span class="p">]</span>
  50. <span class="n">Avatar</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
  51. </pre></div>
  52. </div>
  53. <p>Templates:</p>
  54. <div class="highlight-html"><div class="highlight"><pre><span></span>{{ url_for(&#39;avatar&#39;,text = user.username )}}
  55. </pre></div>
  56. </div>
  57. </div>
  58. <div class="section" id="config">
  59. <h2>1.3 Config<a class="headerlink" href="#config" title="Permalink to this headline">¶</a></h2>
  60. <p>AVATAR_URL = &#8220;The avatar url,default &#8216;avatar&#8217;&#8221;</p>
  61. <div class="toctree-wrapper compound">
  62. <ul class="simple">
  63. </ul>
  64. </div>
  65. </div>
  66. </div>
  67. <div class="section" id="indices-and-tables">
  68. <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
  69. <ul class="simple">
  70. <li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
  71. <li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
  72. <li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
  73. </ul>
  74. </div>
  75. </div>
  76. </div>
  77. </div>
  78. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  79. <div class="sphinxsidebarwrapper">
  80. <h3><a href="#">Table Of Contents</a></h3>
  81. <ul>
  82. <li><a class="reference internal" href="#">Welcome to Flask-Avatar&#8217;s documentation!</a><ul>
  83. <li><a class="reference internal" href="#installation">1.1 Installation</a></li>
  84. <li><a class="reference internal" href="#usage">1.2 Usage</a></li>
  85. <li><a class="reference internal" href="#config">1.3 Config</a></li>
  86. </ul>
  87. </li>
  88. <li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
  89. </ul>
  90. <div class="relations">
  91. <h3>Related Topics</h3>
  92. <ul>
  93. <li><a href="#">Documentation overview</a><ul>
  94. </ul></li>
  95. </ul>
  96. </div>
  97. <div role="note" aria-label="source link">
  98. <h3>This Page</h3>
  99. <ul class="this-page-menu">
  100. <li><a href="_sources/index.txt"
  101. rel="nofollow">Show Source</a></li>
  102. </ul>
  103. </div>
  104. <div id="searchbox" style="display: none" role="search">
  105. <h3>Quick search</h3>
  106. <form class="search" action="search.html" method="get">
  107. <input type="text" name="q" />
  108. <input type="submit" value="Go" />
  109. <input type="hidden" name="check_keywords" value="yes" />
  110. <input type="hidden" name="area" value="default" />
  111. </form>
  112. </div>
  113. <script type="text/javascript">$('#searchbox').show(0);</script>
  114. </div>
  115. </div>
  116. <div class="clearer"></div>
  117. </div>
  118. <div class="footer">
  119. &copy;2016, honmaple.
  120. |
  121. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.1</a>
  122. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
  123. |
  124. <a href="_sources/index.txt"
  125. rel="nofollow">Page source</a>
  126. </div>
  127. </body>
  128. </html>