Add documentation for extra-settings parameter.

nephila · May 20, 2014 · f19fa33 · f19fa33
1 parent a3ca6c3
commit f19fa33
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/docs/reference.rst b/docs/reference.rst
@@ -59,6 +59,8 @@ advanced usage:
 * ``--list-plugins``, ``-P``: List plugins that's going to be installed and
   configured for the project; this will not alter the virtualenv or create the
   project;
+* ``--extra-settings``: Path to a file with extra variables to append to generated settings file. It doesn't need to be
+  a Python file, its content is blindly copied in the project settings.
 
 
 .. _dj-database-url: https://github.com/kennethreitz/dj-database-url
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -57,6 +57,14 @@ This can be helpful to customize the virtualenv:
 
 See :ref:`arguments` for arguments reference
 
+Custom settings
+---------------
+
+If want or need to provide custom settings **before** the initial database sync is run, use `--extra-settings`
+parameter.
+To use this option, pass the path to a file as argument: its content is going to be appended to the generated
+settings file.
+
 
 HOWTO
 -----