[Python-modules-commits] [flask-mongoengine] 01/02: New upstream version 0.9.3
Adrian Vondendriesch
discostu-guest at moszumanska.debian.org
Fri Jun 9 16:27:54 UTC 2017
This is an automated email from the git hooks/post-receive script.
discostu-guest pushed a commit to branch master
in repository flask-mongoengine.
commit 4816e2276bf6023534a7172afd4908d90c6bc9ba
Author: Adrian Vondendriesch <adrian.vondendriesch at credativ.de>
Date: Wed May 31 14:20:11 2017 +0200
New upstream version 0.9.3
---
AUTHORS | 38 +++
LICENSE | 31 ++
MANIFEST.in | 10 +
PKG-INFO | 291 +++++++++++++++++
README.rst | 57 ++++
docs/Makefile | 130 ++++++++
docs/_static/debugtoolbar.png | Bin 0 -> 76895 bytes
docs/_themes/README | 31 ++
docs/_themes/flask/static/flasky.css_t | 345 +++++++++++++++++++++
docs/_themes/flask/theme.conf | 4 +
docs/_themes/flask_small/layout.html | 22 ++
docs/_themes/flask_small/static/flasky.css_t | 287 +++++++++++++++++
docs/_themes/flask_small/theme.conf | 10 +
docs/_themes/flask_theme_support.py | 86 +++++
docs/changelog.rst | 106 +++++++
docs/conf.py | 221 +++++++++++++
docs/index.rst | 266 ++++++++++++++++
docs/make.bat | 155 +++++++++
flask_mongoengine.egg-info/PKG-INFO | 291 +++++++++++++++++
flask_mongoengine.egg-info/SOURCES.txt | 38 +++
flask_mongoengine.egg-info/dependency_links.txt | 1 +
flask_mongoengine.egg-info/not-zip-safe | 1 +
flask_mongoengine.egg-info/requires.txt | 4 +
flask_mongoengine.egg-info/top_level.txt | 1 +
flask_mongoengine/__init__.py | 211 +++++++++++++
flask_mongoengine/connection.py | 127 ++++++++
flask_mongoengine/json.py | 36 +++
flask_mongoengine/operation_tracker.py | 312 +++++++++++++++++++
flask_mongoengine/pagination.py | 167 ++++++++++
flask_mongoengine/panels.py | 62 ++++
flask_mongoengine/sessions.py | 90 ++++++
.../templates/panels/mongo-panel.html | 171 ++++++++++
flask_mongoengine/wtf/__init__.py | 2 +
flask_mongoengine/wtf/base.py | 41 +++
flask_mongoengine/wtf/fields.py | 186 +++++++++++
flask_mongoengine/wtf/models.py | 22 ++
flask_mongoengine/wtf/orm.py | 286 +++++++++++++++++
setup.cfg | 20 ++
setup.py | 76 +++++
39 files changed, 4235 insertions(+)
diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..f7e8428
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,38 @@
+The PRIMARY AUTHORS are (and/or have been):
+
+Ross Lawley <ross.lawley at gmail.com>
+Bright Dadson <brightdadson at gmail.com>
+Jorge Bastida <me at jorgebastida.com>
+Dan Jacob https://bitbucket.org/danjac
+Marat Khabibullin https://bitbucket.org/maratfm
+Streetlife.com
+atroche - https://github.com/atroche
+Rodrigue Cloutier
+Thomas Steinacher
+Anthony Nemitz
+Nauman Ahmad
+
+
+CONTRIBUTORS
+
+Dervived from the git logs, inevitably incomplete but all of whom and others
+have submitted patches, reported bugs and generally helped make MongoEngine
+that much better:
+
+* Dragos - https://github.com/cdragos
+* IamFive - https://github.com/IamFive
+* mickey06 - https://github.com/mickey06
+* Serge S. Koval - https://github.com/mrjoes
+* Marcus Carlsson - https://github.com/xintron
+* RealJTG - https://github.com/RealJTG
+* Peter D. Gray
+* Massimo Santini
+* Len Buckens - https://github.com/buckensl
+* Garito - https://github.com/garito
+* Jérôme Lafréchoux - https://github.com/lafrech
+* Bruno Belarmino - https://github.com/brunobelarmino
+* Sibelius Seraphini - https://github.com/sibelius
+* Denny Huang - https://github.com/denny0223
+* Stefan Wojcik - https://github.com/wojcikstefan
+* John Cass - https://github.com/jcass77
+* Aly Sivji - https://github.com/alysivji
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..5b1cd1b
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,31 @@
+Copyright (c) 2010-2016 See AUTHORS.
+
+Some rights reserved.
+
+Redistribution and use in source and binary forms, 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 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, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
diff --git a/MANIFEST.in b/MANIFEST.in
new file mode 100644
index 0000000..7873e36
--- /dev/null
+++ b/MANIFEST.in
@@ -0,0 +1,10 @@
+include MANIFEST.in
+include README.rst
+include LICENSE
+include AUTHORS
+recursive-include flask_mongoengine/templates *.html
+recursive-include docs *
+recursive-exclude docs *.pyc
+recursive-exclude docs *.pyo
+prune docs/_build
+prune docs/_themes/.git
\ No newline at end of file
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..d3ac1ed
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,291 @@
+Metadata-Version: 1.1
+Name: flask-mongoengine
+Version: 0.9.3
+Summary: Flask-MongoEngine is a Flask extension that provides integration with MongoEngine and WTF model forms.
+Home-page: https://github.com/mongoengine/flask-mongoengine
+Author: Ross Lawley
+Author-email: ross.lawley at gmail.com
+License: BSD
+Description: Flask-MongoEngine
+ =================
+
+ A Flask extension that provides integration with `MongoEngine <http://mongoengine.org/>`_.
+ For more information on MongoEngine please check out the `MongoEngine Documentation <http://docs.mongoengine.org/>`_.
+
+ It handles connection management for your app.
+ You can also use `WTForms <http://wtforms.simplecodes.com/>`_ as model forms for your models.
+
+ Installing Flask-MongoEngine
+ ============================
+
+ Install with **pip**::
+
+ pip install flask-mongoengine
+
+ Configuration
+ =============
+
+ Basic setup is easy, just fetch the extension::
+
+ from flask import Flask
+ from flask_mongoengine import MongoEngine
+
+ app = Flask(__name__)
+ app.config.from_pyfile('the-config.cfg')
+ db = MongoEngine(app)
+
+ Or, if you are setting up your database before your app is initialized, as is the case with application factories::
+
+ from flask import Flask
+ from flask_mongoengine import MongoEngine
+ db = MongoEngine()
+ ...
+ app = Flask(__name__)
+ app.config.from_pyfile('the-config.cfg')
+ db.init_app(app)
+
+
+ By default, Flask-MongoEngine assumes that the :program:`mongod` instance is running
+ on **localhost** on port **27017**, and you wish to connect to the database named **test**.
+
+ If MongoDB is running elsewhere, you should provide the :attr:`host` and :attr:`port` settings
+ in the `'MONGODB_SETTINGS'` dictionary wih `app.config`.::
+
+ app.config['MONGODB_SETTINGS'] = {
+ 'db': 'project1',
+ 'host': '192.168.1.35',
+ 'port': 12345
+ }
+
+ If the database requires authentication, the :attr:`username` and :attr:`password`
+ arguments should be provided `'MONGODB_SETTINGS'` dictionary wih `app.config`.::
+
+ app.config['MONGODB_SETTINGS'] = {
+ 'db': 'project1',
+ 'username':'webapp',
+ 'password':'pwd123'
+ }
+
+ Uri style connections are also supported, just supply the uri as the :attr:`host`
+ in the `'MONGODB_SETTINGS'` dictionary with `app.config`. **Note that database name from uri has priority over name.** ::
+
+ app.config['MONGODB_SETTINGS'] = {
+ 'db': 'project1',
+ 'host': 'mongodb://localhost/database_name'
+ }
+
+ Connection settings may also be provided individually by prefixing the setting with `'MONGODB_'` in the `app.config`.::
+
+ app.config['MONGODB_DB'] = 'project1'
+ app.config['MONGODB_HOST'] = '192.168.1.35'
+ app.config['MONGODB_PORT'] = 12345
+ app.config['MONGODB_USERNAME'] = 'webapp'
+ app.config['MONGODB_PASSWORD'] = 'pwd123'
+
+
+ Custom Queryset
+ ===============
+
+ flask-mongoengine attaches the following methods to Mongoengine's default QuerySet:
+
+ * **get_or_404**: works like .get(), but calls abort(404) if the object DoesNotExist.
+ * **first_or_404**: same as above, except for .first().
+ * **paginate**: paginates the QuerySet. Takes two arguments, *page* and *per_page*.
+ * **paginate_field**: paginates a field from one document in the QuerySet.
+ Arguments: *field_name*, *doc_id*, *page*, *per_page*.
+
+ Examples::
+
+ # 404 if object doesn't exist
+ def view_todo(todo_id):
+ todo = Todo.objects.get_or_404(_id=todo_id)
+ ..
+
+ # Paginate through todo
+ def view_todos(page=1):
+ paginated_todos = Todo.objects.paginate(page=page, per_page=10)
+
+ # Paginate through tags of todo
+ def view_todo_tags(todo_id, page=1):
+ todo = Todo.objects.get_or_404(_id=todo_id)
+ paginated_tags = todo.paginate_field('tags', page, per_page=10)
+
+ Properties of the pagination object include: iter_pages, next, prev, has_next,
+ has_prev, next_num, prev_num.
+
+ In the template::
+
+ {# Display a page of todos #}
+ <ul>
+ {% for todo in paginated_todos.items %}
+ <li>{{ todo.title }}</li>
+ {% endfor %}
+ </ul>
+
+ {# Macro for creating navigation links #}
+ {% macro render_navigation(pagination, endpoint) %}
+ <div class=pagination>
+ {% for page in pagination.iter_pages() %}
+ {% if page %}
+ {% if page != pagination.page %}
+ <a href="{{ url_for(endpoint, page=page) }}">{{ page }}</a>
+ {% else %}
+ <strong>{{ page }}</strong>
+ {% endif %}
+ {% else %}
+ <span class=ellipsis>…</span>
+ {% endif %}
+ {% endfor %}
+ </div>
+ {% endmacro %}
+
+ {{ render_navigation(paginated_todos, 'view_todos') }}
+
+
+ MongoEngine and WTForms
+ =======================
+
+ flask-mongoengine automatically generates WTForms from MongoEngine models::
+
+ from flask_mongoengine.wtf import model_form
+
+ class User(db.Document):
+ email = db.StringField(required=True)
+ first_name = db.StringField(max_length=50)
+ last_name = db.StringField(max_length=50)
+
+ class Content(db.EmbeddedDocument):
+ text = db.StringField()
+ lang = db.StringField(max_length=3)
+
+ class Post(db.Document):
+ title = db.StringField(max_length=120, required=True, validators=[validators.InputRequired(message=u'Missing title.'),])
+ author = db.ReferenceField(User)
+ tags = db.ListField(db.StringField(max_length=30))
+ content = db.EmbeddedDocumentField(Content)
+
+ PostForm = model_form(Post)
+
+ def add_post(request):
+ form = PostForm(request.POST)
+ if request.method == 'POST' and form.validate():
+ # do something
+ redirect('done')
+ return render_template('add_post.html', form=form)
+
+ For each MongoEngine field, the most appropriate WTForm field is used.
+ Parameters allow the user to provide hints if the conversion is not implicit::
+
+ PostForm = model_form(Post, field_args={'title': {'textarea': True}})
+
+ Supported parameters:
+
+ For fields with `choices`:
+
+ - `multiple` to use a SelectMultipleField
+ - `radio` to use a RadioField
+
+ For `StringField`:
+
+ - `password` to use a PasswordField
+ - `textarea` to use a TextAreaField
+
+ (By default, a StringField is converted into a TextAreaField if and only if it has no max_length.)
+
+
+ Supported fields
+ ----------------
+
+ * StringField
+ * BinaryField
+ * URLField
+ * EmailField
+ * IntField
+ * FloatField
+ * DecimalField
+ * BooleanField
+ * DateTimeField
+ * **ListField** (using wtforms.fields.FieldList )
+ * SortedListField (duplicate ListField)
+ * **EmbeddedDocumentField** (using wtforms.fields.FormField and generating inline Form)
+ * **ReferenceField** (using wtforms.fields.SelectFieldBase with options loaded from QuerySet or Document)
+ * DictField
+
+ Not currently supported field types:
+ ------------------------------------
+
+ * ObjectIdField
+ * GeoLocationField
+ * GenericReferenceField
+
+ Session Interface
+ =================
+
+ To use MongoEngine as your session store simple configure the session interface::
+
+ from flask_mongoengine import MongoEngine, MongoEngineSessionInterface
+
+ app = Flask(__name__)
+ db = MongoEngine(app)
+ app.session_interface = MongoEngineSessionInterface(db)
+
+
+ Debug Toolbar Panel
+ ===================
+
+ .. image:: _static/debugtoolbar.png
+ :target: #debug-toolbar-panel
+
+ If you use the Flask-DebugToolbar you can add
+ `'flask_mongoengine.panels.MongoDebugPanel'` to the `DEBUG_TB_PANELS` config
+ list and then it will automatically track your queries::
+
+ from flask import Flask
+ from flask_debugtoolbar import DebugToolbarExtension
+
+ app = Flask(__name__)
+ app.config['DEBUG_TB_PANELS'] = ['flask_mongoengine.panels.MongoDebugPanel']
+ db = MongoEngine(app)
+ toolbar = DebugToolbarExtension(app)
+
+
+
+ Upgrading
+ =========
+
+ 0.6 to 0.7
+ ----------
+
+ `ListFieldPagination` order of arguments have been changed to be more logical::
+
+ # Old order
+ ListFieldPagination(self, queryset, field_name, doc_id, page, per_page, total)
+
+ # New order
+ ListFieldPagination(self, queryset, doc_id, field_name, page, per_page, total)
+
+
+ Credits
+ =======
+
+ Inspired by two repos:
+
+ `danjac <https://bitbucket.org/danjac/flask-mongoengine>`_
+ `maratfm <https://bitbucket.org/maratfm/wtforms>`_
+
+Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 2.6
+Classifier: Programming Language :: Python :: 2.7
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.2
+Classifier: Programming Language :: Python :: 3.3
+Classifier: Programming Language :: Python :: 3.4
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
diff --git a/README.rst b/README.rst
new file mode 100755
index 0000000..71b1052
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,57 @@
+=================
+Flask-MongoEngine
+=================
+:Info: MongoEngine for Flask web applications.
+:Repository: https://github.com/MongoEngine/flask-mongoengine
+
+.. image:: https://travis-ci.org/MongoEngine/flask-mongoengine.svg?branch=master
+ :target: https://travis-ci.org/MongoEngine/flask-mongoengine
+
+.. image:: https://coveralls.io/repos/github/MongoEngine/flask-mongoengine/badge.svg?branch=master
+ :target: https://coveralls.io/github/MongoEngine/flask-mongoengine?branch=master
+
+About
+=====
+Flask-MongoEngine is a Flask extension that provides integration with MongoEngine. It handles connection management for your app.
+You can also use WTForms as model forms for your models.
+
+Documentation
+=============
+You can find the documentation at https://flask-mongoengine.readthedocs.io
+
+Installation
+============
+You can install this package using pypi: ``pip install flask-mongoengine``
+
+Tests
+=====
+To run the test suite, ensure you are running a local copy of Flask-MongoEngine
+and run: ``python setup.py nosetests``.
+
+To run the test suite on every supported versions of Python, PyPy and MongoEngine you can use ``tox``.
+Ensure tox and each supported Python, PyPy versions are installed in your environment:
+
+.. code-block:: shell
+
+ # Install tox
+ $ pip install tox
+ # Run the test suites
+ $ tox
+
+To run a single or selected test suits, use the nosetest convention. E.g.
+
+.. code-block:: shell
+
+ $ python setup.py nosetests --tests tests/example_test.py:ExampleTestClass.example_test_method
+
+Contributing
+============
+We welcome contributions! see the `Contribution guidelines <https://github.com/MongoEngine/flask-mongoengine/blob/master/CONTRIBUTING.rst>`_
+
+Community
+=========
+- `#flask-mongoengine IRC channel <http://webchat.freenode.net/?channels=flask-mongoengine>`_
+
+License
+=======
+Flask-MongoEngine is distributed under MIT license, see LICENSE for more details.
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..8e9f867
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/flask-unittest.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/flask-unittest.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/flask-unittest"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/flask-unittest"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
diff --git a/docs/_static/debugtoolbar.png b/docs/_static/debugtoolbar.png
new file mode 100644
index 0000000..14b8ea9
Binary files /dev/null and b/docs/_static/debugtoolbar.png differ
diff --git a/docs/_themes/README b/docs/_themes/README
new file mode 100644
index 0000000..b3292bd
--- /dev/null
+++ b/docs/_themes/README
@@ -0,0 +1,31 @@
+Flask Sphinx Styles
+===================
+
+This repository contains sphinx styles for Flask and Flask related
+projects. To use this style in your Sphinx documentation, follow
+this guide:
+
+1. put this folder as _themes into your docs folder. Alternatively
+ you can also use git submodules to check out the contents there.
+2. add this to your conf.py:
+
+ sys.path.append(os.path.abspath('_themes'))
+ html_theme_path = ['_themes']
+ html_theme = 'flask'
+
+The following themes exist:
+
+- 'flask' - the standard flask documentation theme for large
+ projects
+- 'flask_small' - small one-page theme. Intended to be used by
+ very small addon libraries for flask.
+
+The following options exist for the flask_small theme:
+
+ [options]
+ index_logo = '' filename of a picture in _static
+ to be used as replacement for the
+ h1 in the index.rst file.
+ index_logo_height = 120px height of the index logo
+ github_fork = '' repository name on github for the
+ "fork me" badge
diff --git a/docs/_themes/flask/static/flasky.css_t b/docs/_themes/flask/static/flasky.css_t
new file mode 100644
index 0000000..ed9378e
--- /dev/null
+++ b/docs/_themes/flask/static/flasky.css_t
@@ -0,0 +1,345 @@
+/*
+ * flasky.css_t
+ * ~~~~~~~~~~~~
+ *
+ * Sphinx stylesheet -- flasky theme based on nature theme.
+ *
+ * :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+ at import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+ font-family: 'Georgia', serif;
+ font-size: 17px;
+ background-color: #ddd;
+ color: #000;
+ margin: 0;
+ padding: 0;
+}
+
+div.document {
+ background: #fafafa;
+}
+
+div.documentwrapper {
+ float: left;
+ width: 100%;
+}
+
+div.bodywrapper {
+ margin: 0 0 0 230px;
+}
+
+hr {
+ border: 1px solid #B1B4B6;
+}
+
+div.body {
+ background-color: #ffffff;
+ color: #3E4349;
+ padding: 0 30px 30px 30px;
+ min-height: 34em;
+}
+
+img.floatingflask {
+ padding: 0 0 10px 10px;
+ float: right;
+}
+
+div.footer {
+ position: absolute;
+ right: 0;
+ margin-top: -70px;
+ text-align: right;
+ color: #888;
+ padding: 10px;
+ font-size: 14px;
+}
+
+div.footer a {
+ color: #888;
+ text-decoration: underline;
+}
+
+div.related {
+ line-height: 32px;
+ color: #888;
+}
+
+div.related ul {
+ padding: 0 0 0 10px;
+}
+
+div.related a {
+ color: #444;
+}
+
+div.sphinxsidebar {
+ font-size: 14px;
+ line-height: 1.5;
+}
+
+div.sphinxsidebarwrapper {
+ padding: 0 20px;
+}
+
+div.sphinxsidebarwrapper p.logo {
+ padding: 20px 0 10px 0;
+ margin: 0;
+ text-align: center;
+}
+
+div.sphinxsidebar h3,
+div.sphinxsidebar h4 {
+ font-family: 'Garamond', 'Georgia', serif;
+ color: #222;
+ font-size: 24px;
+ font-weight: normal;
+ margin: 20px 0 5px 0;
+ padding: 0;
+}
+
+div.sphinxsidebar h4 {
+ font-size: 20px;
+}
+
+div.sphinxsidebar h3 a {
+ color: #444;
+}
+
+div.sphinxsidebar p {
+ color: #555;
+ margin: 10px 0;
+}
+
+div.sphinxsidebar ul {
+ margin: 10px 0;
+ padding: 0;
+ color: #000;
+}
+
+div.sphinxsidebar a {
+ color: #444;
+ text-decoration: none;
+}
+
+div.sphinxsidebar a:hover {
+ text-decoration: underline;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #ccc;
+ font-family: 'Georgia', serif;
+ font-size: 1em;
+}
+
+/* -- body styles ----------------------------------------------------------- */
+
+a {
+ color: #004B6B;
+ text-decoration: underline;
+}
+
+a:hover {
+ color: #6D4100;
+ text-decoration: underline;
+}
+
+div.body {
+ padding-bottom: 40px; /* saved for footer */
+}
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+ font-family: 'Garamond', 'Georgia', serif;
+ font-weight: normal;
+ margin: 30px 0px 10px 0px;
+ padding: 0;
+}
+
+div.body h1 { margin-top: 0; padding-top: 20px; font-size: 240%; }
+div.body h2 { font-size: 180%; }
+div.body h3 { font-size: 150%; }
+div.body h4 { font-size: 130%; }
+div.body h5 { font-size: 100%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+ color: white;
+ padding: 0 4px;
+ text-decoration: none;
+}
+
+a.headerlink:hover {
+ color: #444;
+ background: #eaeaea;
+}
+
+div.body p, div.body dd, div.body li {
+ line-height: 1.4em;
+}
+
+div.admonition {
+ background: #fafafa;
+ margin: 20px -30px;
+ padding: 10px 30px;
+ border-top: 1px solid #ccc;
+ border-bottom: 1px solid #ccc;
+}
+
+div.admonition p.admonition-title {
+ font-family: 'Garamond', 'Georgia', serif;
+ font-weight: normal;
+ font-size: 24px;
+ margin: 0 0 10px 0;
+ padding: 0;
+ line-height: 1;
+}
+
+div.admonition p.last {
+ margin-bottom: 0;
+}
+
+div.highlight{
+ background-color: white;
+}
+
+dt:target, .highlight {
+ background: #FAF3E8;
+}
+
+div.note {
+ background-color: #eee;
+ border: 1px solid #ccc;
+}
+
+div.seealso {
+ background-color: #ffc;
+ border: 1px solid #ff6;
+}
+
+div.topic {
+ background-color: #eee;
+}
+
+div.warning {
+ background-color: #ffe4e4;
+ border: 1px solid #f66;
+}
+
+p.admonition-title {
+ display: inline;
+}
+
+p.admonition-title:after {
+ content: ":";
+}
+
+pre, tt {
+ font-family: 'Consolas', 'Menlo', 'Deja Vu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+ font-size: 0.9em;
+}
+
+img.screenshot {
+}
+
+tt.descname, tt.descclassname {
+ font-size: 0.95em;
+}
+
+tt.descname {
+ padding-right: 0.08em;
+}
+
+img.screenshot {
+ -moz-box-shadow: 2px 2px 4px #eee;
+ -webkit-box-shadow: 2px 2px 4px #eee;
+ box-shadow: 2px 2px 4px #eee;
+}
+
+table.docutils {
+ border: 1px solid #888;
+ -moz-box-shadow: 2px 2px 4px #eee;
+ -webkit-box-shadow: 2px 2px 4px #eee;
+ box-shadow: 2px 2px 4px #eee;
+}
+
+table.docutils td, table.docutils th {
+ border: 1px solid #888;
+ padding: 0.25em 0.7em;
+}
+
+table.field-list, table.footnote {
+ border: none;
+ -moz-box-shadow: none;
+ -webkit-box-shadow: none;
+ box-shadow: none;
+}
+
+table.footnote {
+ margin: 15px 0;
+ width: 100%;
+ border: 1px solid #eee;
+}
+
+table.field-list th {
+ padding: 0 0.8em 0 0;
+}
+
+table.field-list td {
+ padding: 0;
+}
+
+table.footnote td {
+ padding: 0.5em;
+}
+
+dl {
+ margin: 0;
+ padding: 0;
+}
+
+dl dd {
+ margin-left: 30px;
... 3516 lines suppressed ...
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/python-modules/packages/flask-mongoengine.git
More information about the Python-modules-commits
mailing list