19 | {% endif %}
20 | {% endblock %}
21 | {% block sidebar1 %}{% endblock %}
22 | {% block sidebar2 %}{% endblock %}
23 |
--------------------------------------------------------------------------------
/tests/__init__.py:
--------------------------------------------------------------------------------
1 | import unittest
2 | import flask
3 | import mongoengine
4 |
5 |
6 | class FlaskMongoEngineTestCase(unittest.TestCase):
7 | """Parent class of all test cases"""
8 |
9 | def setUp(self):
10 | self.app = flask.Flask(__name__)
11 | self.app.config['MONGODB_DB'] = 'test_db'
12 | self.app.config['TESTING'] = True
13 | self.ctx = self.app.app_context()
14 | self.ctx.push()
15 | # Mongoengine keep a global state of the connections that must be
16 | # reset before each test.
17 | # Given it doesn't expose any method to get the list of registered
18 | # connections, we have to do the cleaning by hand...
19 | mongoengine.connection._connection_settings.clear()
20 | mongoengine.connection._connections.clear()
21 | mongoengine.connection._dbs.clear()
22 |
23 | def tearDown(self):
24 | self.ctx.pop()
25 |
--------------------------------------------------------------------------------
/examples/biggerapp/views.py:
--------------------------------------------------------------------------------
1 | import flask
2 | from models import Todo
3 |
4 | def index():
5 | # As a list to test debug toolbar
6 | Todo.objects().delete() # Removes
7 | Todo(title="Simple todo A", text="12345678910").save() # Insert
8 | Todo(title="Simple todo B", text="12345678910").save() # Insert
9 | Todo.objects(title__contains="B").update(set__text="Hello world") # Update
10 | todos = list(Todo.objects[:10])
11 | todos = Todo.objects.all()
12 | return flask.render_template('index.html', todos=todos)
13 |
14 | def pagination():
15 | Todo.objects().delete()
16 | for i in range(10):
17 | Todo(title='Simple todo {}'.format(i), text="12345678910").save() # Insert
18 |
19 | page_num = int(flask.request.args.get('page') or 1)
20 | todos_page = Todo.objects.paginate(page=page_num, per_page=3)
21 |
22 | return flask.render_template('pagination.html', todos_page=todos_page)
23 |
--------------------------------------------------------------------------------
/examples/biggerapp/static/style.css:
--------------------------------------------------------------------------------
1 | body { font-family: sans-serif; background: #eee; }
2 | a, h1, h2 { color: #377BA8; }
3 | h1, h2 { font-family: 'Georgia', serif; margin: 0; }
4 | h1 { border-bottom: 2px solid #eee; }
5 | h2 { font-size: 1.2em; }
6 | .page { margin: 2em auto; width: 35em; border: 5px solid #ccc;
7 | padding: 0.8em; background: white; }
8 | .entries { list-style: none; margin: 0; padding: 0; }
9 | .entries li { margin: 0.8em 1.2em; }
10 | .entries li h2 { margin-left: -1em; }
11 | .add-entry { font-size: 0.9em; border-bottom: 1px solid #ccc; }
12 | .add-entry dl { font-weight: bold; }
13 | .metanav { text-align: right; font-size: 0.8em; padding: 0.3em;
14 | margin-bottom: 1em; background: #fafafa; }
15 | .flash { background: #CEE5F5; padding: 0.5em;
16 | border: 1px solid #AACBE2; }
17 | .error { background: #F0D6D6; padding: 0.5em; }
18 |
--------------------------------------------------------------------------------
/examples/simpleapp/static/style.css:
--------------------------------------------------------------------------------
1 | body { font-family: sans-serif; background: #eee; }
2 | a, h1, h2 { color: #377BA8; }
3 | h1, h2 { font-family: 'Georgia', serif; margin: 0; }
4 | h1 { border-bottom: 2px solid #eee; }
5 | h2 { font-size: 1.2em; }
6 |
7 | .page { margin: 2em auto; width: 35em; border: 5px solid #ccc;
8 | padding: 0.8em; background: white; }
9 | .entries { list-style: none; margin: 0; padding: 0; }
10 | .entries li { margin: 0.8em 1.2em; }
11 | .entries li h2 { margin-left: -1em; }
12 | .add-entry { font-size: 0.9em; border-bottom: 1px solid #ccc; }
13 | .add-entry dl { font-weight: bold; }
14 | .metanav { text-align: right; font-size: 0.8em; padding: 0.3em;
15 | margin-bottom: 1em; background: #fafafa; }
16 | .flash { background: #CEE5F5; padding: 0.5em;
17 | border: 1px solid #AACBE2; }
18 | .error { background: #F0D6D6; padding: 0.5em; }
19 |
--------------------------------------------------------------------------------
/examples/biggerapp/templates/pagination.html:
--------------------------------------------------------------------------------
1 | {% extends "layout.html" %}
2 |
3 | {# Macro for creating navigation links #}
4 | {% macro render_navigation(pagination, endpoint) %}
5 | | Time (ms) | 40 |Size | 41 | {% if title == 'Queries' %} 42 |Operation | 43 |Collection | 44 |Query | 45 |Ordering | 46 |Skip | 47 |Limit | 48 |Data | 49 | {% elif title == 'Inserts' %} 50 |Document | 51 |Safe | 52 | {% elif title == 'Removes' %} 53 |Query / Id | 54 |Safe | 55 | {% elif title == 'Updates' %} 56 |Query | 57 |Update | 58 |Safe | 59 |Multi | 60 |Upsert | 61 | {% endif %} 62 |Stack Trace | 63 |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| slow_query_limit %}style="color:red;" {% endif %}> 69 | {{ query.time|round(3) }} | 70 |{{ query.size|round(2) }}Kb | 71 | {% if title == "Queries" %} 72 | {% set colspan = 10 %} 73 |{{ query.operation|title }} | 74 |{{ query.collection }} | 75 |{% if query.query %}{{ query.query|safe }}{% endif %} | 76 |{% if query.ordering %}{{ query.ordering }}{% endif %} | 77 |{% if query.skip %}{{ query.skip }}{% endif %} | 78 |{% if query.limit %}{{ query.limit }}{% endif %} | 79 |Toggle | 80 | {% elif title == "Inserts" %} 81 | {% set colspan = 5 %} 82 |{{ query.document|safe }} 83 | | 84 |{{ query.safe }} | 85 | {% elif title == 'Removes' %} 86 | {% set colspan = 5 %} 87 |
88 | {{ query.spec_or_id|safe }}
89 | |
90 | {{ query.safe }} |
91 | {% elif title == 'Updates' %}
92 | {% set colspan = 8 %}
93 |
94 | {{ query.spec|safe }}
95 | |
96 |
97 | {{ query.document|safe }}
98 | |
99 | {{ query.safe }} | 100 |{{ query.multi }} | 101 |{{ query.upsert }} | 102 | {% endif %} 103 |Toggle | 104 |
108 | |
110 | ||||||||||||||||||
114 |
|
142 | ||||||||||||||||||
No {{ title|lower }} recorded
148 | {% endif %} 149 | {% endmacro %} 150 | 151 | {{ render_stats("Queries", queries, slow_query_limit)}} 152 | {{ render_stats("Removes", removes, slow_query_limit)}} 153 | {{ render_stats("Inserts", inserts, slow_query_limit)}} 154 | {{ render_stats("Updates", updates, slow_query_limit)}} 155 | 156 | 172 | -------------------------------------------------------------------------------- /flask_mongoengine/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | from __future__ import absolute_import 3 | 4 | import inspect 5 | 6 | import mongoengine 7 | from flask import Flask, abort, current_app 8 | from mongoengine.base.fields import BaseField 9 | from mongoengine.errors import ( 10 | DoesNotExist, 11 | MultipleObjectsReturned, 12 | ValidationError, 13 | ) 14 | from mongoengine.queryset import QuerySet 15 | 16 | from .connection import * 17 | from .json import override_json_encoder 18 | from .pagination import * 19 | from .sessions import * 20 | from .wtf import WtfBaseField 21 | 22 | VERSION = (0, 9, 5) 23 | 24 | 25 | def get_version(): 26 | """Return the VERSION as a string, e.g. for VERSION == (0, 9, 2), 27 | return '0.9.2'. 28 | """ 29 | return '.'.join(map(str, VERSION)) 30 | 31 | 32 | __version__ = get_version() 33 | 34 | 35 | def _patch_base_field(obj, name): 36 | """ 37 | If the object submitted has a class whose base class is 38 | mongoengine.base.fields.BaseField, then monkey patch to 39 | replace it with flask_mongoengine.wtf.WtfBaseField. 40 | 41 | @note: WtfBaseField is an instance of BaseField - but 42 | gives us the flexibility to extend field parameters 43 | and settings required of WTForm via model form generator. 44 | 45 | @see: flask_mongoengine.wtf.base.WtfBaseField. 46 | @see: model_form in flask_mongoengine.wtf.orm 47 | 48 | @param obj: MongoEngine instance in which we should locate the class. 49 | @param name: Name of an attribute which may or may not be a BaseField. 50 | """ 51 | # TODO is there a less hacky way to accomplish the same level of 52 | # extensibility/control? 53 | 54 | # get an attribute of the MongoEngine class and return if it's not 55 | # a class 56 | cls = getattr(obj, name) 57 | if not inspect.isclass(cls): 58 | return 59 | 60 | # if it is a class, inspect all of its parent classes 61 | cls_bases = list(cls.__bases__) 62 | 63 | # if any of them is a BaseField, replace it with WtfBaseField 64 | for index, base in enumerate(cls_bases): 65 | if base == BaseField: 66 | cls_bases[index] = WtfBaseField 67 | cls.__bases__ = tuple(cls_bases) 68 | break 69 | 70 | # re-assign the class back to the MongoEngine instance 71 | delattr(obj, name) 72 | setattr(obj, name, cls) 73 | 74 | 75 | def _include_mongoengine(obj): 76 | """ 77 | Copy all of the attributes from mongoengine and mongoengine.fields 78 | onto obj (which should be an instance of the MongoEngine class). 79 | """ 80 | # TODO why do we need this? What's wrong with importing from the 81 | # original modules? 82 | for module in (mongoengine, mongoengine.fields): 83 | for attr_name in module.__all__: 84 | if not hasattr(obj, attr_name): 85 | setattr(obj, attr_name, getattr(module, attr_name)) 86 | 87 | # patch BaseField if available 88 | _patch_base_field(obj, attr_name) 89 | 90 | 91 | def current_mongoengine_instance(): 92 | """Return a MongoEngine instance associated with current Flask app.""" 93 | me = current_app.extensions.get('mongoengine', {}) 94 | for k, v in me.items(): 95 | if isinstance(k, MongoEngine): 96 | return k 97 | 98 | 99 | class MongoEngine(object): 100 | """Main class used for initialization of Flask-MongoEngine.""" 101 | 102 | def __init__(self, app=None, config=None): 103 | _include_mongoengine(self) 104 | 105 | self.app = None 106 | self.Document = Document 107 | self.DynamicDocument = DynamicDocument 108 | 109 | if app is not None: 110 | self.init_app(app, config) 111 | 112 | def init_app(self, app, config=None): 113 | if not app or not isinstance(app, Flask): 114 | raise Exception('Invalid Flask application instance') 115 | 116 | self.app = app 117 | 118 | app.extensions = getattr(app, 'extensions', {}) 119 | 120 | # Make documents JSON serializable 121 | override_json_encoder(app) 122 | 123 | if 'mongoengine' not in app.extensions: 124 | app.extensions['mongoengine'] = {} 125 | 126 | if self in app.extensions['mongoengine']: 127 | # Raise an exception if extension already initialized as 128 | # potentially new configuration would not be loaded. 129 | raise Exception('Extension already initialized') 130 | 131 | if not config: 132 | # If not passed a config then we read the connection settings 133 | # from the app config. 134 | config = app.config 135 | 136 | # Obtain db connection(s) 137 | connections = create_connections(config) 138 | 139 | # Store objects in application instance so that multiple apps do not 140 | # end up accessing the same objects. 141 | s = {'app': app, 'conn': connections} 142 | app.extensions['mongoengine'][self] = s 143 | 144 | @property 145 | def connection(self): 146 | """ 147 | Return MongoDB connection(s) associated with this MongoEngine 148 | instance. 149 | """ 150 | return current_app.extensions['mongoengine'][self]['conn'] 151 | 152 | 153 | class BaseQuerySet(QuerySet): 154 | """Mongoengine's queryset extended with handy extras.""" 155 | 156 | def get_or_404(self, *args, **kwargs): 157 | """ 158 | Get a document and raise a 404 Not Found error if it doesn't 159 | exist. 160 | """ 161 | try: 162 | return self.get(*args, **kwargs) 163 | except DoesNotExist: 164 | message = kwargs.get('message', None) 165 | abort(404, message) if message else abort(404) 166 | 167 | def first_or_404(self, message=None): 168 | """Same as get_or_404, but uses .first, not .get.""" 169 | obj = self.first() 170 | return obj if obj else abort(404, message) if message else abort(404) 171 | 172 | def paginate(self, page, per_page, **kwargs): 173 | """ 174 | Paginate the QuerySet with a certain number of docs per page 175 | and return docs for a given page. 176 | """ 177 | return Pagination(self, page, per_page) 178 | 179 | def paginate_field(self, field_name, doc_id, page, per_page, total=None): 180 | """ 181 | Paginate items within a list field from one document in the 182 | QuerySet. 183 | """ 184 | # TODO this doesn't sound useful at all - remove in next release? 185 | item = self.get(id=doc_id) 186 | count = getattr(item, field_name + "_count", '') 187 | total = total or count or len(getattr(item, field_name)) 188 | return ListFieldPagination(self, doc_id, field_name, page, per_page, 189 | total=total) 190 | 191 | 192 | class Document(mongoengine.Document): 193 | """Abstract document with extra helpers in the queryset class""" 194 | 195 | meta = {'abstract': True, 196 | 'queryset_class': BaseQuerySet} 197 | 198 | def paginate_field(self, field_name, page, per_page, total=None): 199 | """Paginate items within a list field.""" 200 | # TODO this doesn't sound useful at all - remove in next release? 201 | count = getattr(self, field_name + "_count", '') 202 | total = total or count or len(getattr(self, field_name)) 203 | return ListFieldPagination(self.__class__.objects, self.pk, field_name, 204 | page, per_page, total=total) 205 | 206 | 207 | class DynamicDocument(mongoengine.DynamicDocument): 208 | """Abstract Dynamic document with extra helpers in the queryset class""" 209 | 210 | meta = {'abstract': True, 211 | 'queryset_class': BaseQuerySet} 212 | -------------------------------------------------------------------------------- /tests/test_connection.py: -------------------------------------------------------------------------------- 1 | import mongoengine 2 | from mongoengine.context_managers import switch_db 3 | from nose import SkipTest 4 | from nose.tools import assert_raises 5 | import pymongo 6 | from pymongo.errors import InvalidURI 7 | from pymongo.read_preferences import ReadPreference 8 | 9 | from flask_mongoengine import MongoEngine 10 | 11 | from tests import FlaskMongoEngineTestCase 12 | 13 | 14 | class ConnectionTestCase(FlaskMongoEngineTestCase): 15 | 16 | def _do_persist(self, db, alias=None): 17 | """Initialize a test Flask application and persist some data in 18 | MongoDB, ultimately asserting that the connection works. 19 | """ 20 | if alias: 21 | class Todo(db.Document): 22 | meta = {'db_alias': alias} 23 | title = db.StringField(max_length=60) 24 | text = db.StringField() 25 | done = db.BooleanField(default=False) 26 | else: 27 | class Todo(db.Document): 28 | title = db.StringField(max_length=60) 29 | text = db.StringField() 30 | done = db.BooleanField(default=False) 31 | 32 | db.init_app(self.app) 33 | Todo.drop_collection() 34 | 35 | # Test persist 36 | todo = Todo() 37 | todo.text = "Sample" 38 | todo.title = "Testing" 39 | todo.done = True 40 | s_todo = todo.save() 41 | 42 | f_to = Todo.objects().first() 43 | self.assertEqual(s_todo.title, f_to.title) 44 | 45 | def test_simple_connection(self): 46 | """Make sure a simple connection to a standalone MongoDB works.""" 47 | db = MongoEngine() 48 | self.app.config['MONGODB_SETTINGS'] = { 49 | 'ALIAS': 'simple_conn', 50 | 'HOST': 'localhost', 51 | 'PORT': 27017, 52 | 'DB': 'flask_mongoengine_test_db' 53 | } 54 | self._do_persist(db, alias='simple_conn') 55 | 56 | def test_host_as_uri_string(self): 57 | """Make sure we can connect to a standalone MongoDB if we specify 58 | the host as a MongoDB URI. 59 | """ 60 | db = MongoEngine() 61 | self.app.config['MONGODB_HOST'] = 'mongodb://localhost:27017/flask_mongoengine_test_db' 62 | self._do_persist(db) 63 | 64 | def test_mongomock_host_as_uri_string(self): 65 | """Make sure we switch to mongomock if we specify the host as a mongomock URI. 66 | """ 67 | if mongoengine.VERSION < (0, 9, 0): 68 | raise SkipTest('Mongomock not supported for mongoengine < 0.9.0') 69 | db = MongoEngine() 70 | self.app.config['MONGODB_HOST'] = 'mongomock://localhost:27017/flask_mongoengine_test_db' 71 | with assert_raises(RuntimeError) as exc: 72 | self._do_persist(db) 73 | assert str(exc.exception) == 'You need mongomock installed to mock MongoEngine.' 74 | 75 | def test_mongomock_as_param(self): 76 | """Make sure we switch to mongomock when providing IS_MOCK option. 77 | """ 78 | if mongoengine.VERSION < (0, 9, 0): 79 | raise SkipTest('Mongomock not supported for mongoengine < 0.9.0') 80 | db = MongoEngine() 81 | self.app.config['MONGODB_SETTINGS'] = { 82 | 'ALIAS': 'simple_conn', 83 | 'HOST': 'localhost', 84 | 'PORT': 27017, 85 | 'DB': 'flask_mongoengine_test_db', 86 | 'IS_MOCK': True 87 | } 88 | with assert_raises(RuntimeError) as exc: 89 | self._do_persist(db, alias='simple_conn') 90 | assert str(exc.exception) == 'You need mongomock installed to mock MongoEngine.' 91 | 92 | def test_host_as_list(self): 93 | """Make sure MONGODB_HOST can be a list hosts.""" 94 | db = MongoEngine() 95 | self.app.config['MONGODB_SETTINGS'] = { 96 | 'ALIAS': 'host_list', 97 | 'HOST': ['localhost:27017'], 98 | 'DB': 'flask_mongoengine_test_db' 99 | } 100 | self._do_persist(db, alias='host_list') 101 | 102 | def test_multiple_connections(self): 103 | """Make sure establishing multiple connections to a standalone 104 | MongoDB and switching between them works. 105 | """ 106 | db = MongoEngine() 107 | self.app.config['MONGODB_SETTINGS'] = [ 108 | { 109 | 'ALIAS': 'default', 110 | 'DB': 'flask_mongoengine_test_db_1', 111 | 'HOST': 'localhost', 112 | 'PORT': 27017 113 | }, 114 | { 115 | 'ALIAS': 'alternative', 116 | 'DB': 'flask_mongoengine_test_db_2', 117 | 'HOST': 'localhost', 118 | 'PORT': 27017 119 | }, 120 | ] 121 | 122 | class Todo(db.Document): 123 | title = db.StringField(max_length=60) 124 | text = db.StringField() 125 | done = db.BooleanField(default=False) 126 | meta = {'db_alias': 'alternative'} 127 | 128 | db.init_app(self.app) 129 | Todo.drop_collection() 130 | 131 | # Test saving a doc via the default connection 132 | with switch_db(Todo, 'default') as Todo: 133 | todo = Todo() 134 | todo.text = "Sample" 135 | todo.title = "Testing" 136 | todo.done = True 137 | s_todo = todo.save() 138 | 139 | f_to = Todo.objects().first() 140 | self.assertEqual(s_todo.title, f_to.title) 141 | 142 | # Make sure the doc doesn't exist in the alternative db 143 | with switch_db(Todo, 'alternative') as Todo: 144 | doc = Todo.objects().first() 145 | self.assertEqual(doc, None) 146 | 147 | # Make sure switching back to the default connection shows the doc 148 | with switch_db(Todo, 'default') as Todo: 149 | doc = Todo.objects().first() 150 | self.assertNotEqual(doc, None) 151 | 152 | def test_connection_with_invalid_uri(self): 153 | """Make sure connecting via an invalid URI raises an InvalidURI 154 | exception. 155 | """ 156 | self.app.config['MONGODB_HOST'] = 'mongo://localhost' 157 | self.assertRaises(InvalidURI, MongoEngine, self.app) 158 | 159 | def test_ingnored_mongodb_prefix_config(self): 160 | """Config starting by MONGODB_ but not used by flask-mongoengine 161 | should be ignored. 162 | """ 163 | db = MongoEngine() 164 | self.app.config['MONGODB_HOST'] = 'mongodb://localhost:27017/flask_mongoengine_test_db_prod' 165 | # Invalid host, should trigger exception if used 166 | self.app.config['MONGODB_TEST_HOST'] = 'dummy://localhost:27017/test' 167 | self._do_persist(db) 168 | 169 | def test_connection_kwargs(self): 170 | """Make sure additional connection kwargs work.""" 171 | 172 | # Figure out whether to use "MAX_POOL_SIZE" or "MAXPOOLSIZE" based 173 | # on PyMongo version (former was changed to the latter as described 174 | # in https://jira.mongodb.org/browse/PYTHON-854) 175 | # TODO remove once PyMongo < 3.0 support is dropped 176 | if pymongo.version_tuple[0] >= 3: 177 | MAX_POOL_SIZE_KEY = 'MAXPOOLSIZE' 178 | else: 179 | MAX_POOL_SIZE_KEY = 'MAX_POOL_SIZE' 180 | 181 | self.app.config['MONGODB_SETTINGS'] = { 182 | 'ALIAS': 'tz_aware_true', 183 | 'DB': 'flask_mongoengine_testing_tz_aware', 184 | 'TZ_AWARE': True, 185 | 'READ_PREFERENCE': ReadPreference.SECONDARY, 186 | MAX_POOL_SIZE_KEY: 10, 187 | } 188 | db = MongoEngine() 189 | db.init_app(self.app) 190 | self.assertTrue(db.connection.codec_options.tz_aware) 191 | self.assertEqual(db.connection.max_pool_size, 10) 192 | self.assertEqual( 193 | db.connection.read_preference, 194 | ReadPreference.SECONDARY 195 | ) 196 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # flask-script documentation build configuration file, created by 4 | # sphinx-quickstart on Wed Jun 23 08:26:41 2010. 5 | # 6 | # This file is execfile()d with the current directory set to its containing dir. 7 | # 8 | # Note that not all possible configuration values are present in this 9 | # autogenerated file. 10 | # 11 | # All configuration values have a default; values that are commented out 12 | # serve to show the default. 13 | 14 | import sys, os 15 | 16 | # If extensions (or modules to document with autodoc) are in another directory, 17 | # add these directories to sys.path here. If the directory is relative to the 18 | # documentation root, use os.path.abspath to make it absolute, like shown here. 19 | sys.path.append(os.path.abspath('_themes')) 20 | 21 | # -- General configuration ----------------------------------------------------- 22 | 23 | # If your documentation needs a minimal Sphinx version, state it here. 24 | #needs_sphinx = '1.0' 25 | 26 | # Add any Sphinx extension module names here, as strings. They can be extensions 27 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 28 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx'] 29 | 30 | # Add any paths that contain templates here, relative to this directory. 31 | templates_path = ['_templates'] 32 | 33 | # The suffix of source filenames. 34 | source_suffix = '.rst' 35 | 36 | # The encoding of source files. 37 | #source_encoding = 'utf-8-sig' 38 | 39 | # The master toctree document. 40 | master_doc = 'index' 41 | 42 | # General information about the project. 43 | project = u'Flask-MongoEngine' 44 | copyright = u'2010-2020, Streetlife and others' 45 | 46 | # The version info for the project you're documenting, acts as replacement for 47 | # |version| and |release|, also used in various other places throughout the 48 | # built documents. 49 | # 50 | import flask_mongoengine 51 | # The short X.Y version. 52 | version = flask_mongoengine.__version__ 53 | # The full version, including alpha/beta/rc tags. 54 | release = flask_mongoengine.__version__ 55 | 56 | # The language for content autogenerated by Sphinx. Refer to documentation 57 | # for a list of supported languages. 58 | #language = None 59 | 60 | # There are two options for replacing |today|: either, you set today to some 61 | # non-false value, then it is used: 62 | #today = '' 63 | # Else, today_fmt is used as the format for a strftime call. 64 | #today_fmt = '%B %d, %Y' 65 | 66 | # List of patterns, relative to source directory, that match files and 67 | # directories to ignore when looking for source files. 68 | exclude_patterns = ['_build'] 69 | 70 | # The reST default role (used for this markup: `text`) to use for all documents. 71 | #default_role = None 72 | 73 | # If true, '()' will be appended to :func: etc. cross-reference text. 74 | #add_function_parentheses = True 75 | 76 | # If true, the current module name will be prepended to all description 77 | # unit titles (such as .. function::). 78 | #add_module_names = True 79 | 80 | # If true, sectionauthor and moduleauthor directives will be shown in the 81 | # output. They are ignored by default. 82 | #show_authors = False 83 | 84 | # The name of the Pygments (syntax highlighting) style to use. 85 | #pygments_style = 'sphinx' 86 | 87 | # A list of ignored prefixes for module index sorting. 88 | #modindex_common_prefix = [] 89 | 90 | 91 | # -- Options for HTML output --------------------------------------------------- 92 | 93 | # The theme to use for HTML and HTML Help pages. See the documentation for 94 | # a list of builtin themes. 95 | html_theme = 'flask_small' 96 | 97 | html_theme_options = { 98 | 'index_logo': '', 99 | 'github_fork': None 100 | } 101 | # Theme options are theme-specific and customize the look and feel of a theme 102 | # further. For a list of options available for each theme, see the 103 | # documentation. 104 | #html_theme_options = {} 105 | 106 | # Add any paths that contain custom themes here, relative to this directory. 107 | html_theme_path = ['_themes'] 108 | 109 | # The name for this set of Sphinx documents. If None, it defaults to 110 | # "