Modified docs

unbit · Nov 10, 2016 · 2534675 · 2534675
1 parent 9660c86
commit 2534675
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 12 deletions.
diff --git a/docs/cache.rst b/docs/cache.rst
@@ -18,6 +18,15 @@ change settings to:
         }
     }
 
+django-confy
+------------
+
+if you're using `django-confy`, you can use url like:
+
+.. code-block:: sh
+    
+    CACHE_URL=uwsgi://..
+
 
 Settings
 --------
@@ -26,5 +35,5 @@ Settings
 
 - ``False`` - raises Exception if ``uwsgi`` cannot be imported.
 - ``True`` (default) - if uwsgi is not importable this cache backend will alias
-  to LocMemCache. Note that south or other mangement commands might try to load
+  to LocMemCache. Note that south or other management commands might try to load
   the cache backend so this is why it's the default.
diff --git a/docs/conf.py b/docs/conf.py
@@ -28,7 +28,7 @@
 master_doc = 'index'
 
 project = u'django-uwsgi'
-copyright = u'2014, Eugene MechanisM'
+copyright = u'2016, Eugene MechanisM'
 
 version = __version__
 release = __version__

diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -8,11 +8,11 @@ Add ``'django_uwsgi',`` to your ``INSTALLED_APPS`` in ``settings.py``:
 
 .. code-block:: py
 
-    INSTALLED_APPS += ('django_uwsgi',)
+    INSTALLED_APPS += ['django_uwsgi',]
 
 
 Add django_uwsgi into ``urls.py``:
 
 .. code-block:: py
 
-    urlpatterns += patterns('', url(r'^admin/uwsgi/', include('django_uwsgi.urls')),)
+    urlpatterns += [url(r'^admin/uwsgi/', include('django_uwsgi.urls')),]
diff --git a/docs/emperor.rst b/docs/emperor.rst
@@ -1,13 +1,13 @@
 Emperor
 =======
 
-you can use `django_uwsgi.emperor` module if you want to store vassals configs in PostgreSQL database.
+you can use `django_uwsgi.emperor` module if you want to store vassals configs in `PostgreSQL`_ database.
 
 Simply add `'django_uwsgi.emperor',` into `INSTALLED_APPS`
 
 .. code-block:: py
 
-   INSTALLED_APPS += ('django_uwsgi.emperor',)
+   INSTALLED_APPS += ['django_uwsgi.emperor',]
 
 
 Populate vassals via django admin interface and start uwsgi with command like:
@@ -17,4 +17,6 @@ Populate vassals via django admin interface and start uwsgi with command like:
    uwsgi --plugin emperor_pg --emperor "pg://host=127.0.0.1 user=foobar dbname=emperor;SELECT name,config,ts FROM vassals WHERE enabled = True"
 
 
-Each time vassal added, removed, updated, enabled or disabled - uwsgi will start/stop it or reload.
+Each time vassal added, removed, updated, enabled or disabled - uwsgi will start/stop it or reload.
+
+.. _PostgreSQL: http://uwsgi-docs.readthedocs.org/en/latest/ImperialMonitors.html#pg-scan-a-postgresql-table-for-configuration
diff --git a/docs/features.rst b/docs/features.rst
@@ -9,7 +9,7 @@ Features
 * Django :doc:`command` ``runuwsgi`` (with live autoreload when DEBUG is True)
 * uWSGI config generator
 * Django CBV Mixins based on uWSGI decorators
-* Forms to send log message and signal to uWSGI via admin interface
+* Forms to send log messages and signals to uWSGI via admin interface
 
 
 Some features are not added into repo or not yet implemented(See :doc:`todo`)

diff --git a/docs/integrations.rst b/docs/integrations.rst
@@ -8,7 +8,7 @@ If you're using `django-debug-toolbar`_, you can add:
 
 .. code-block:: py
 
-    DEBUG_TOOLBAR_PANELS += ('django_uwsgi.panels.UwsgiPanel',)
+    DEBUG_TOOLBAR_PANELS += ['django_uwsgi.panels.UwsgiPanel',]
 
 
 .. _django-debug-toolbar: http://django-debug-toolbar.readthedocs.org/en/latest/
@@ -34,4 +34,7 @@ And you don't have to add `django_uwsgi` into urls.py
 .. image:: screenshots/screenshot3.png
 
 
+.. image:: screenshots/screenshot4.png
+
+
 .. _Wagtail: http://wagtail.io
diff --git a/docs/todo.rst b/docs/todo.rst
@@ -11,6 +11,3 @@ Todo
 
 
 Some code is borrowed from projects I did earlier and some code is still not added yet, but does exists in my projects.
-
-.. _PostgreSQL: http://uwsgi-docs.readthedocs.org/en/latest/ImperialMonitors.html#pg-scan-a-postgresql-table-for-configuration
-.. _MongoDB: http://uwsgi-docs.readthedocs.org/en/latest/ImperialMonitors.html#mongodb-scan-mongodb-collections-for-configuration