Reformat lftools cmd docs for sphinx and click 52/4052/1
authorThanh Ha <thanh.ha@linuxfoundation.org>
Wed, 8 Mar 2017 04:16:52 +0000 (23:16 -0500)
committerThanh Ha <thanh.ha@linuxfoundation.org>
Wed, 8 Mar 2017 04:30:07 +0000 (23:30 -0500)
commit17243a05e7d200901c64b06fd55e2f650c0fd7cf
treef2794976f1dca6c093f3a3a1f20d0bc36e6415d8
parent9291391e220eefbb8bac04a079b87f54a6fc9a70
Reformat lftools cmd docs for sphinx and click

Sphinx and Click have very different docstring formats unfortunately
which makes it difficult for us to share the same documentation in both
places without breaking the format of the other. This patch proposes a
compromise where we use sphinxcontrib-programoutput to copy the output
of Click --help documentation and place it inside of Sphinx. Not the
best but ensures we only write documentation once.

This patch also fixes the documentation for the Version command as it
was inaccurate or misleading in some places.

Also disable PyDocLint rule for backslashes since Click uses \b as a
keyword for text wrapping.

Change-Id: Ica09079d339065912fb5a78dccb24ee9a3063abc
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
.coafile
docs/commands/index.rst [new file with mode: 0644]
docs/commands/version.rst [new file with mode: 0644]
docs/conf.py
docs/index.rst
docs/shell.rst [deleted file]
lftools/cli/version.py
requirements.txt