From 58955c2e7cc4838f31f388b7afc345fc218f4018 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 3 Dec 2014 19:07:03 +0100 Subject: [PATCH] docs: use sphinx arg parser extension to document args --- docs/source/conf.py | 4 ++++ docs/source/reference/index.rst | 6 ++++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 7a5bedc..9d7d571 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -33,6 +33,10 @@ extensions = [ 'sphinx.ext.todo', ] +if 1: + extensions += ['sphinxarg.ext'] + sys.path.append(os.path.join(os.path.dirname(__file__), "..", "..", "client", "cli")) + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst index 16410f1..3baf54a 100644 --- a/docs/source/reference/index.rst +++ b/docs/source/reference/index.rst @@ -3,5 +3,7 @@ Client Reference Here is a reference of all the BAM cli commands. -bam init - Initializes a Project. Available in a few variations. +.. argparse:: + :module: bam + :func: create_argparse + :prog: bam