improve doc

docs/create_app.rst

@@ -0,0 +1,10 @@
+create_app
+==========
+
+The ``create_app`` method is the most important. This is where the application
+is created. It is mostly used when running your application through
+``gunicorn``.
+
+.. currentmodule:: burpui
+
+.. autofunction:: create_app

docs/developer.rst

@@ -5,6 +5,7 @@ Developer Guide
    :maxdepth: 2
 
    development
+   create_app
    api
    backend
    parser

docs/gunicorn.rst

@@ -22,8 +22,8 @@ You will then be able to launch `Burp-UI`_ this way:
 
 
 When using ``gunicorn``, the command line options are not available. Instead,
-run the `Burp-UI`_ ``init`` method directly. Here are the parameters you can
-play with:
+run the `Burp-UI`_ ``create_app`` method directly. Here are the parameters you
+can play with:
 
 - conf: Path to the `Burp-UI`_ configuration file
 - verbose: Verbosity level between 0 and 4
@@ -140,7 +140,7 @@ Then you need to fix some permissions:
 
 Finally you can restart your ``burp-server``.
 
-.. note:: The above commands are meant for *default* setup, you may need to
+.. note:: The above commands are meant for *default* setup. You may need to
           adapt the paths.
 
 Reverse-Proxy

docs/installation.rst

@@ -101,20 +101,27 @@ Options
 
 ::
 
-   usage: burp-ui [-h] [-v] [-d] [-V] [-c <CONFIG>] [-l <FILE>]
-                  [-m <agent|server>]
+    usage: burp-ui [-h] [-v] [-d] [-V] [-c <CONFIG>] [-l <FILE>]
+                   [-i <MIGRATIONSDIR>] [-m <agent|server|celery|manage>]
+                   ...
 
-   optional arguments:
-     -h, --help            show this help message and exit
-     -v, --verbose         increase output verbosity (e.g., -vv is more than -v)
-     -d, --debug           enable debug mode
-     -V, --version         print version and exit
-     -c <CONFIG>, --config <CONFIG>
-                           configuration file
-     -l <FILE>, --logfile <FILE>
-                           output logs in defined file
-     -m <agent|server>, --mode <agent|server>
-                           application mode (server or agent)
+    positional arguments:
+      remaining
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      -v, --verbose         increase output verbosity (e.g., -vv is more verbose
+                            than -v)
+      -d, --debug           enable debug mode
+      -V, --version         print version and exit
+      -c <CONFIG>, --config <CONFIG>
+                            configuration file
+      -l <FILE>, --logfile <FILE>
+                            output logs in defined file
+      -i <MIGRATIONSDIR>, --migrations <MIGRATIONSDIR>
+                            migrations directory
+      -m <agent|server|celery|manage>, --mode <agent|server|celery|manage>
+                            application mode
 
 
 .. _Flask: http://flask.pocoo.org/