Add docs

.gitignore

@@ -2,3 +2,4 @@
 .ropeproject
 *.pyc
 dist
+_build

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "docs/_themes"]
+	path = docs/_themes
+	url = git://github.com/lepture/flask-sphinx-themes.git

.vimrc

@@ -0,0 +1,2 @@
+let g:pymode_lint_checker = 'pep8,pyflakes,mccabe,pylint'
+let NERDTreeIgnore += ['\.egg$', '\.egg-info$', '\.ropeproject$', '\.tags$', 'dist']

LICENSE

@@ -1,165 +1,32 @@
-                   GNU LESSER GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
-  This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
-  0. Additional Definitions.
-
-  As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
-  "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
-  An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
-  A "Combined Work" is a work produced by combining or linking an
-Application with the Library.  The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
-  The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
-  The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
-  1. Exception to Section 3 of the GNU GPL.
-
-  You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
-  2. Conveying Modified Versions.
-
-  If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
-   a) under this License, provided that you make a good faith effort to
-   ensure that, in the event an Application does not supply the
-   function or data, the facility still operates, and performs
-   whatever part of its purpose remains meaningful, or
-
-   b) under the GNU GPL, with none of the additional permissions of
-   this License applicable to that copy.
-
-  3. Object Code Incorporating Material from Library Header Files.
-
-  The object code form of an Application may incorporate material from
-a header file that is part of the Library.  You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
-   a) Give prominent notice with each copy of the object code that the
-   Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the object code with a copy of the GNU GPL and this license
-   document.
-
-  4. Combined Works.
-
-  You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
-   a) Give prominent notice with each copy of the Combined Work that
-   the Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-   document.
-
-   c) For a Combined Work that displays copyright notices during
-   execution, include the copyright notice for the Library among
-   these notices, as well as a reference directing the user to the
-   copies of the GNU GPL and this license document.
-
-   d) Do one of the following:
-
-       0) Convey the Minimal Corresponding Source under the terms of this
-       License, and the Corresponding Application Code in a form
-       suitable for, and under terms that permit, the user to
-       recombine or relink the Application with a modified version of
-       the Linked Version to produce a modified Combined Work, in the
-       manner specified by section 6 of the GNU GPL for conveying
-       Corresponding Source.
-
-       1) Use a suitable shared library mechanism for linking with the
-       Library.  A suitable mechanism is one that (a) uses at run time
-       a copy of the Library already present on the user's computer
-       system, and (b) will operate properly with a modified version
-       of the Library that is interface-compatible with the Linked
-       Version.
-
-   e) Provide Installation Information, but only if you would otherwise
-   be required to provide such information under section 6 of the
-   GNU GPL, and only to the extent that such information is
-   necessary to install and execute a modified version of the
-   Combined Work produced by recombining or relinking the
-   Application with a modified version of the Linked Version. (If
-   you use option 4d0, the Installation Information must accompany
-   the Minimal Corresponding Source and Corresponding Application
-   Code. If you use option 4d1, you must provide the Installation
-   Information in the manner specified by section 6 of the GNU GPL
-   for conveying Corresponding Source.)
-
-  5. Combined Libraries.
-
-  You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
-   a) Accompany the combined library with a copy of the same work based
-   on the Library, uncombined with any other library facilities,
-   conveyed under the terms of this License.
-
-   b) Give prominent notice with the combined library that part of it
-   is a work based on the Library, and explaining where to find the
-   accompanying uncombined form of the same work.
-
-  6. Revised Versions of the GNU Lesser General Public License.
-
-  The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
-  Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
-  If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.
+Copyright (c) 2012 by Kirill Klenov.
+
+Some rights reserved.
+
+Redistribution and use in source and binary forms of the software as well
+as documentation, with or without modification, are permitted provided
+that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above
+  copyright notice, this list of conditions and the following
+  disclaimer in the documentation and/or other materials provided
+  with the distribution.
+
+* The names of the contributors may not be used to endorse or
+  promote products derived from this software without specific
+  prior written permission.
+
+THIS SOFTWARE AND DOCUMENTATION IS PROVIDED BY THE COPYRIGHT HOLDERS AND
+CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
+NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
+OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE AND DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGE.

Makefile

@@ -25,8 +25,8 @@ test: audit
 audit:
 	pylama $(MODULE) -i E501
 
-.PHONY: doc
-doc:
+.PHONY: docs
+docs:
 	python setup.py build_sphinx --source-dir=docs/ --build-dir=docs/_build --all-files
 	python setup.py upload_sphinx --upload-dir=docs/_build/html
 

README.rst

@@ -18,8 +18,8 @@ to specific folder (saves related paths).
 Requirements
 =============
 
-- python 2.5 (importlib)
-- python 2.6
+- python 2.6 (importlib)
+- python 2.7
 - Flask >= 0.8
 
 
@@ -85,7 +85,7 @@ at https://github.com/klen/Flask-Collect/issues
 Contributing
 ============
 
-Development of adrest happens at github: https://github.com/klen/Flask-Collect
+Development of flask-collect happens at github: https://github.com/klen/Flask-Collect
 
 
 Contributors
@@ -97,8 +97,8 @@ Contributors
 License
 =======
 
-Licensed under a `GNU lesser general public license`_.
+Licensed under a `BSD license`_.
 
 
-.. _GNU lesser general public license: http://www.gnu.org/copyleft/lesser.html
+.. _BSD license: http://www.linfo.org/bsdlicense.html
 .. _klen: http://klen.github.com/

docs/api.rst

@@ -0,0 +1,14 @@
+API
+---
+
+.. module:: flask.ext.collect
+
+This part of the documentation documents all the public classes and
+functions in Flask-Collect.
+
+
+Configuration
+`````````````
+
+.. autoclass:: Collect
+   :members:

docs/conf.py

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+import os
+import sys
+
+from flask_collect import __version__ as release
+
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx']
+templates_path = ['_templates']
+source_suffix = '.rst'
+master_doc = 'index'
+project = u'Flask-Collect'
+copyright = u'2012, Kirill Klenov'
+version = '.'.join(release.split('.')[:2])
+exclude_patterns = ['_build']
+html_use_modindex = False
+html_show_sphinx = False
+htmlhelp_basename = 'Flask-Collectdoc'
+latex_documents = [
+    ('index', 'Flask-Collect.tex', u'Flask-Collect Documentation',
+        u'Kirill Klenov', 'manual'),
+]
+latex_use_modindex = False
+latex_elements = {
+    'fontpkg':      r'\usepackage{mathpazo}',
+    'papersize':    'a4paper',
+    'pointsize':    '12pt',
+    'preamble':     r'\usepackage{flaskstyle}'
+}
+latex_use_parts = True
+latex_additional_files = ['flaskstyle.sty', 'logo.pdf']
+man_pages = [
+    ('index', 'flask-mixer', u'Flask-Collect Documentation',
+     [u'Kirill Klenov'], 1)
+]
+pygments_style = 'tango'
+html_theme = 'default'
+html_theme_options = {}
+
+sys.path.append(os.path.abspath('_themes'))
+html_theme_path = ['_themes']
+html_theme = 'flask'

docs/config.rst

@@ -0,0 +1,23 @@
+.. _configuration:
+
+Configuration
+=============
+
+The following configuration values exist for Flask-SQLAlchemy.
+Flask-SQLAlchemy loads these values from your main Flask config which can
+be populated in various ways.  Note that some of those cannot be modified
+after the engine was created so make sure to configure as early as
+possible and to not modify them at runtime.
+
+Configuration Keys
+------------------
+
+A list of configuration keys currently understood by the extension:
+
+=============================== =========================================
+``COLLECT_STATIC_ROOT``         Path to folder for collect static files.
+                                By default: *<APP_ROOT>/static*.
+
+``COLLECT_STORAGE``             Import path to storage backend.
+                                By default: *flask.ext.collect.storage.file*.
+=============================== =========================================

docs/contents.rst.inc

@@ -0,0 +1,55 @@
+User's Guide
+------------
+
+This part of the documentation will show you how to get started in using
+Flask-Collect.
+
+.. toctree::
+   :maxdepth: 2
+
+   quickstart
+   installation
+   config
+
+API Reference
+-------------
+
+If you are looking for information on a specific function, class or
+method, this part of the documentation is for you.
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+
+Additional Notes
+----------------
+
+Bug tracker
+~~~~~~~~~~~
+
+If you have any suggestions, bug reports or
+annoyances please report them to the issue tracker
+at https://github.com/klen/Flask-Collect/issues
+
+
+Contributing
+~~~~~~~~~~~~
+
+Development of flask-collect happens at github: https://github.com/klen/Flask-Collect
+
+
+Contributors
+~~~~~~~~~~~~
+
+* klen_ (Kirill Klenov)
+
+
+License
+~~~~~~~
+
+Licensed under a `BSD license`_.
+
+
+.. _BSD license: http://www.linfo.org/bsdlicense.html
+.. _klen: http://klen.github.com/

docs/index.rst

@@ -0,0 +1,6 @@
+.. automodule:: flask.ext.collect
+
+.. _SQLAlchemy: http://www.sqlalchemy.org/
+.. _Flask: http://flask.pocoo.org/
+
+.. include:: contents.rst.inc