Improving docs according to new CLI

MarekSuchanek · Jul 1, 2018 · a1a1d04 · a1a1d04
1 parent ab499cf
commit a1a1d04
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 36 deletions.
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -6,14 +6,13 @@ API
 .. toctree::
    :maxdepth: 3
 
-   repocribro/api.rst
+   repocribro/cli.rst
    repocribro/commands.rst
    repocribro/config.rst
    repocribro/controllers.rst
    repocribro/ext_core.rst
    repocribro/extending.rst
    repocribro/github.rst
-   repocribro/manage.rst
    repocribro/models.rst
    repocribro/repocribro.rst
    repocribro/security.rst
diff --git a/docs/api/repocribro/api.rst b/docs/api/repocribro/api.rst
diff --git a/docs/api/repocribro/manage.rst → docs/api/repocribro/cli.rst b/docs/api/repocribro/manage.rst → docs/api/repocribro/cli.rst
@@ -1,7 +1,7 @@
 repocribro.manage
 =================
 
-.. automodule:: repocribro.manage
+.. automodule:: repocribro.cli
     :members:
     :private-members:
     :special-members:

diff --git a/docs/api/repocribro/commands.rst b/docs/api/repocribro/commands.rst
@@ -1,32 +1,42 @@
 repocribro.commands
 ===================
 
-AssignRoleCommand
------------------
+assign_role
+-----------
 
-.. autoclass:: repocribro.commands.AssignRoleCommand
+.. automodule:: repocribro.commands.assign_role
     :members:
     :private-members:
-    :special-members: __init__
+    :special-members:
     :undoc-members:
-    :show-inheritance:
 
-DbCreateCommand
----------------
 
-.. autoclass:: repocribro.commands.DbCreateCommand
+check_config
+---------
+
+.. automodule:: repocribro.commands.check_config
     :members:
     :private-members:
-    :special-members: __init__
+    :special-members:
     :undoc-members:
-    :show-inheritance:
 
-RepocheckCommand
-----------------
 
-.. autoclass:: repocribro.commands.RepocheckCommand
+db_create
+---------
+
+.. automodule:: repocribro.commands.db_create
     :members:
     :private-members:
-    :special-members: __init__
+    :special-members:
     :undoc-members:
-    :show-inheritance:
+
+
+repocheck
+---------
+
+.. automodule:: repocribro.commands.repocheck
+    :members:
+    :private-members:
+    :special-members:
+    :undoc-members:
+
diff --git a/docs/install/config.rst b/docs/install/config.rst
@@ -1,3 +1,5 @@
+.. _config:
+
 Configuration
 =============
 
@@ -28,6 +30,11 @@ Default config file can be also specified with environment variable:
     >>> from repocribro.app import app
     >>> app.run()
 
+You can also take advantage of `python-dotenv`_ and specify configuration
+in `.env` file.
+
+.. _python-dotenv: https://github.com/theskumar/python-dotenv
+
 Application
 -----------
 

diff --git a/docs/usage/commands.rst b/docs/usage/commands.rst
@@ -5,7 +5,11 @@ There are various command for the app management some are
 provided by Flask extensions, some by repocribro. You can
 use option ``--help`` to get more information.
 
-assign-role
+You can use both ``repocribro`` and ``flask`` commands. The
+configuration must by specified by environenment variable as
+described in :ref:`config`.
+
+assign_role
 -----------
 
 Main purpose for this command is to set the initial admin
@@ -14,7 +18,7 @@ set within administration zone of web interface.
 
 ::
 
-    $ repocribro assign-role --login MarekSuchanek --role admin
+    $ repocribro assign_role --login MarekSuchanek --role admin
     Loaded extensions: core
     Role admin not in DB... adding
     Role admin added to MarekSuchanek
@@ -27,10 +31,10 @@ set within administration zone of web interface.
 For more information:
 ::
 
-    $ repocribro assign-role --help
+    $ repocribro assign_role --help
 
 
-check-config
+check_config
 ------------
 
 Commands for checking configuration currently used by repocribro.
@@ -39,12 +43,12 @@ There are two styles for printing, same syntax as is in the cfg file
 
 ::
 
-    $ repocribro -c my_cfg1.cfg -c my_cfg2.cfg check-config
+    $ repocribro check_config
     [flask]
     secret_key = MySecretKey
     ...
 
-    $ repocribro check-config --style triple
+    $ repocribro check_config --style triple
     flask secret_key MySecretKey
     ...
 
@@ -65,13 +69,14 @@ For more information:
 repocheck
 ---------
 
-*Not implemented yet!*
-
-This command will provide simple checking of one or all
+This command provides simple checking of one or all
 repositories if there are some uncaught events within specified
 time. Main idea is to get the missed events (from webhooks) due
 to app outage.
 
+::
+
+    $ repocribro repocheck --help
 
 runserver
 ---------
@@ -83,7 +88,7 @@ For more information:
 
 ::
 
-    $ repocribro runserver --help
+    $ repocribro run --help