updated documentation

doc/conf.py

@@ -43,6 +43,7 @@ extensions = [
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.viewcode',
+    'sphinx_click.ext'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -142,7 +143,7 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'caromclient', 'Carom Client Documentation',
+    ('man', 'carom-client', 'Carom Client Documentation',
      [author], 1)
 ]
 

doc/developement.rst

@@ -0,0 +1,9 @@
+Developement
+============
+
+Update der Manpages
+-------------------
+
+.. code-block:: bash
+
+   pipenv run sphinx-build -b man doc doc/man

doc/index.rst

@@ -11,6 +11,8 @@ Welcome to Carom Client's documentation!
    :caption: Contents:
 
    api/index
+   man
+   developement
 
 
 

doc/man.rst

@@ -0,0 +1,3 @@
+.. click:: carom.cli:cli
+   :prog: carom-client
+   :show-nested:

doc/man/carom-client.1

@@ -0,0 +1,66 @@
+.\" Man page generated from reStructuredText.
+.
+.TH "CAROM-CLIENT" "1" "04.11.2018" "" "Carom Client"
+.SH NAME
+carom-client \- Carom Client Documentation
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+carom\-client [OPTIONS] COMMAND [ARGS]...
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+Options.INDENT 0.0
+.TP
+.B \-v, \-\-verbosity <verbosity>
+Either CRITICAL, ERROR, WARNING, INFO or DEBUG
+.UNINDENT
+.SH RUN
+.sp
+This command runs the carom\-client daemon process.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+carom\-client run [OPTIONS]
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH AUTHOR
+Robert Einsle
+.SH COPYRIGHT
+2018, Robert Einsle
+.\" Generated by docutils manpage writer.
+.