real manpage coming; refs insomnia-lab#234

well, almost
boyska · Dec 16, 2015 · 0a28c4a · 0a28c4a
1 parent 96053ff
commit 0a28c4a
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 3 deletions.
diff --git a/doc/source/clickdoc.py b/doc/source/clickdoc.py
@@ -35,9 +35,11 @@ def format_param(param):
 
 
 class UsageDirective(SingleArgDirective):
+    optional_arguments = 1
+
     def run(self):
         command = get_command(self.get_arg())
-        ctx = command.make_context( command.name, [])
+        ctx = command.make_context( command.name, self.arguments[1:])
 
         doc = ViewList()
         doc.append(command.get_usage(ctx), '')

diff --git a/doc/source/commands.rst b/doc/source/commands.rst
@@ -0,0 +1,8 @@
+Command-line tools
+=====================
+
+.. toctree::
+   :maxdepth: 1
+
+   /commands/libreant
+   /commands/libreant-db
diff --git a/doc/source/commands/libreant-db.rst b/doc/source/commands/libreant-db.rst
@@ -0,0 +1,21 @@
+Libreant-db
+===========
+
+This program manages the volume database of libreant. It does not handle users db.
+
+Synopsis
+--------
+
+.. click:usage :: cli.libreant_db:libreant_db
+    libreant-db
+
+Options
+-------
+
+.. click:all_options :: cli.libreant_db:libreant_db
+
+Examples
+--------
+
+Environment variables
+----------------------
diff --git a/doc/source/commands/libreant.rst b/doc/source/commands/libreant.rst
@@ -0,0 +1,24 @@
+Libreant
+=========
+
+This command will run the libreant HTTPserver.
+
+Synopsis
+--------
+
+.. click:usage :: cli.libreant:libreant
+
+Summary
+--------
+
+
+Options
+-------
+
+.. click:all_options :: cli.libreant:libreant
+
+Examples
+--------
+
+Environment variables
+----------------------
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -231,8 +231,10 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'libreant', 'libreant Documentation',
-     ['insomnialab'], 1)
+    ('commands/libreant-db', 'libreant-db', 'manage libreant db',
+     ['insomnialab'], 8),
+    ('commands/libreant', 'libreant', '(e)Book archive focused on small grassroot archives',
+     ['insomnialab'], 8),
 ]
 
 # If true, show URL addresses after external links.

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -18,6 +18,7 @@ Contents:
    documentation
    developer
    api/modules
+   commands