diff --git a/deploy/requirements.txt b/deploy/requirements.txt index 0e0b6d8..3daf267 100755 --- a/deploy/requirements.txt +++ b/deploy/requirements.txt @@ -15,4 +15,5 @@ pytz factory_boy django-widget-tweaks django-haystack -elasticsearch \ No newline at end of file +elasticsearch +sphinx diff --git a/docs/conf.py b/docs/conf.py index c1666b0..cc773f3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,9 +51,9 @@ # built documents. # # The short X.Y version. -version = '1.1.5' +version = '1.4' # The full version, including alpha/beta/rc tags. -release = '1.1.5' +release = '1.4.0' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/index.rst b/docs/index.rst index 8ed261d..0292725 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -22,6 +22,8 @@ Add the need apps to INSTALLED_APPS:: 'constance', # see django-constance documentation 'constance.backends.database', + 'widget_tweaks', + 'haystack', ) @@ -44,3 +46,30 @@ Assuming that you are storing Constance values in the Database:: CONSTANCE_BACKEND = 'constance.backends.database.DatabaseBackend' +Though, the default and recommended backend is Redis. You can read more +here: https://github.com/comoga/django-constance#redis-default + + + +Haystack +-------- + +We're using Haystack to handle the search. Here is an example using +Elasticsearch:: + + HAYSTACK_CONNECTIONS = { + 'default': { + 'ENGINE': 'haystack.backends.elasticsearch_backend.ElasticsearchSearchEngine', + 'URL': 'http://127.0.0.1:9200/', + 'INDEX_NAME': 'realestate', + }, + } + +For more info you can look at Haystack documentation: +http://django-haystack.readthedocs.org/en/latest/tutorial.html#modify-your-settings-py + + +RESTful API +----------- + +**djangorestframework**