From b7f994c9d13e70b597f42bce49ca6389cd21e2b2 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 27 Nov 2016 12:13:30 -0800 Subject: convert pcreate and pdistreport to use argparse - add sphinxcontrib-autoprogram - attempt to render output of pcreate, but be unsuccessful --- docs/pscripts/pcreate.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'docs/pscripts') diff --git a/docs/pscripts/pcreate.rst b/docs/pscripts/pcreate.rst index b5ec3f4e2..7159395b7 100644 --- a/docs/pscripts/pcreate.rst +++ b/docs/pscripts/pcreate.rst @@ -6,8 +6,7 @@ ``pcreate`` ----------- -.. program-output:: pcreate --help - :prompt: - :shell: +.. autoprogram:: pyramid.scripts.pcreate:PCreateCommand + :prog: pcreate.py .. seealso:: :ref:`creating_a_project` -- cgit v1.2.3 From bde0ef17af0461799f04ace144526a06c6215776 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 27 Nov 2016 12:49:28 -0800 Subject: fix autoprogram argument - restore argv - use standard Python syntax for string formatting --- docs/pscripts/pcreate.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/pscripts') diff --git a/docs/pscripts/pcreate.rst b/docs/pscripts/pcreate.rst index 7159395b7..648491600 100644 --- a/docs/pscripts/pcreate.rst +++ b/docs/pscripts/pcreate.rst @@ -6,7 +6,7 @@ ``pcreate`` ----------- -.. autoprogram:: pyramid.scripts.pcreate:PCreateCommand +.. autoprogram:: pyramid.scripts.pcreate:PCreateCommand.parser :prog: pcreate.py .. seealso:: :ref:`creating_a_project` -- cgit v1.2.3 From b2f3ed007ef27d24690f40c2ad8415fab9400e98 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 27 Nov 2016 20:01:36 -0800 Subject: still fumbling around with autoprogram, not successful --- docs/pscripts/pdistreport.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'docs/pscripts') diff --git a/docs/pscripts/pdistreport.rst b/docs/pscripts/pdistreport.rst index 1c53fb6e9..3bcd96b00 100644 --- a/docs/pscripts/pdistreport.rst +++ b/docs/pscripts/pdistreport.rst @@ -6,8 +6,7 @@ ``pdistreport`` --------------- -.. program-output:: pdistreport --help - :prompt: - :shell: +.. autoprogram:: pyramid.scripts.pdistreport:parser + :prog: pdistreport.py .. seealso:: :ref:`showing_distributions` -- cgit v1.2.3 From cae3840bc43f54ae55d1e2c97da90cecdf49a95e Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 27 Nov 2016 20:03:45 -0800 Subject: drop '.py' from :prog: argument --- docs/pscripts/pcreate.rst | 2 +- docs/pscripts/pdistreport.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/pscripts') diff --git a/docs/pscripts/pcreate.rst b/docs/pscripts/pcreate.rst index 648491600..476b3d577 100644 --- a/docs/pscripts/pcreate.rst +++ b/docs/pscripts/pcreate.rst @@ -7,6 +7,6 @@ ----------- .. autoprogram:: pyramid.scripts.pcreate:PCreateCommand.parser - :prog: pcreate.py + :prog: pcreate .. seealso:: :ref:`creating_a_project` diff --git a/docs/pscripts/pdistreport.rst b/docs/pscripts/pdistreport.rst index 3bcd96b00..8eebaf8cb 100644 --- a/docs/pscripts/pdistreport.rst +++ b/docs/pscripts/pdistreport.rst @@ -7,6 +7,6 @@ --------------- .. autoprogram:: pyramid.scripts.pdistreport:parser - :prog: pdistreport.py + :prog: pdistreport .. seealso:: :ref:`showing_distributions` -- cgit v1.2.3 From 0c208dd7bf66a41a056514025fa42be8fc428513 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 27 Nov 2016 22:13:03 -0800 Subject: move parser outside of main into own function get_parser(), and call it from pdistreport.rst --- docs/pscripts/pdistreport.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/pscripts') diff --git a/docs/pscripts/pdistreport.rst b/docs/pscripts/pdistreport.rst index 8eebaf8cb..f88ea7fe1 100644 --- a/docs/pscripts/pdistreport.rst +++ b/docs/pscripts/pdistreport.rst @@ -6,7 +6,7 @@ ``pdistreport`` --------------- -.. autoprogram:: pyramid.scripts.pdistreport:parser +.. autoprogram:: pyramid.scripts.pdistreport:get_parser() :prog: pdistreport .. seealso:: :ref:`showing_distributions` -- cgit v1.2.3 From e5b871d5afa0cb2772780013636ee2b830c1fdf1 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 27 Nov 2016 22:19:08 -0800 Subject: remove duplicitous headings --- docs/pscripts/pcreate.rst | 3 --- docs/pscripts/pdistreport.rst | 3 --- 2 files changed, 6 deletions(-) (limited to 'docs/pscripts') diff --git a/docs/pscripts/pcreate.rst b/docs/pscripts/pcreate.rst index 476b3d577..0f23583ba 100644 --- a/docs/pscripts/pcreate.rst +++ b/docs/pscripts/pcreate.rst @@ -3,9 +3,6 @@ .. _pcreate_script: -``pcreate`` ------------ - .. autoprogram:: pyramid.scripts.pcreate:PCreateCommand.parser :prog: pcreate diff --git a/docs/pscripts/pdistreport.rst b/docs/pscripts/pdistreport.rst index f88ea7fe1..200218ad0 100644 --- a/docs/pscripts/pdistreport.rst +++ b/docs/pscripts/pdistreport.rst @@ -3,9 +3,6 @@ .. _pdistreport_script: -``pdistreport`` ---------------- - .. autoprogram:: pyramid.scripts.pdistreport:get_parser() :prog: pdistreport -- cgit v1.2.3 From 6b229c9ef28556942845ac429e10e498fb5dea5f Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 27 Nov 2016 23:56:21 -0800 Subject: indent 4 spaces --- docs/pscripts/pcreate.rst | 4 ++-- docs/pscripts/pdistreport.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'docs/pscripts') diff --git a/docs/pscripts/pcreate.rst b/docs/pscripts/pcreate.rst index 0f23583ba..c48a70acd 100644 --- a/docs/pscripts/pcreate.rst +++ b/docs/pscripts/pcreate.rst @@ -1,9 +1,9 @@ .. index:: - single: pcreate; --help + single: pcreate; --help .. _pcreate_script: .. autoprogram:: pyramid.scripts.pcreate:PCreateCommand.parser - :prog: pcreate + :prog: pcreate .. seealso:: :ref:`creating_a_project` diff --git a/docs/pscripts/pdistreport.rst b/docs/pscripts/pdistreport.rst index 200218ad0..b3c9dffd8 100644 --- a/docs/pscripts/pdistreport.rst +++ b/docs/pscripts/pdistreport.rst @@ -1,9 +1,9 @@ .. index:: - single: pdistreport; --help + single: pdistreport; --help .. _pdistreport_script: .. autoprogram:: pyramid.scripts.pdistreport:get_parser() - :prog: pdistreport + :prog: pdistreport .. seealso:: :ref:`showing_distributions` -- cgit v1.2.3 From 9a22d66e011f93135fa12c1ab1738b7f1ee90312 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Sun, 27 Nov 2016 23:57:22 -0800 Subject: use argparse in prequest; use autoprogram --- docs/pscripts/prequest.rst | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) (limited to 'docs/pscripts') diff --git a/docs/pscripts/prequest.rst b/docs/pscripts/prequest.rst index a15827767..64ed01739 100644 --- a/docs/pscripts/prequest.rst +++ b/docs/pscripts/prequest.rst @@ -1,13 +1,9 @@ .. index:: - single: prequest; --help + single: prequest; --help .. _prequest_script: -``prequest`` ------------- - -.. program-output:: prequest --help - :prompt: - :shell: +.. autoprogram:: pyramid.scripts.prequest:PRequestCommand.parser + :prog: prequest .. seealso:: :ref:`invoking_a_request` -- cgit v1.2.3 From 83ebd45272bee27a56aaf9a6494382da1499c12d Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 28 Nov 2016 01:48:38 -0800 Subject: use argparse in prequest; use autoprogram --- docs/pscripts/proutes.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) (limited to 'docs/pscripts') diff --git a/docs/pscripts/proutes.rst b/docs/pscripts/proutes.rst index 09ed013e1..ee7c209e3 100644 --- a/docs/pscripts/proutes.rst +++ b/docs/pscripts/proutes.rst @@ -3,11 +3,7 @@ .. _proutes_script: -``proutes`` ------------ - -.. program-output:: proutes --help - :prompt: - :shell: +.. autoprogram:: pyramid.scripts.proutes:PRoutesCommand.parser + :prog: proutes .. seealso:: :ref:`displaying_application_routes` -- cgit v1.2.3 From 6e14f62f24dcff03ebc6d27c0c756db449082cfd Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 28 Nov 2016 02:05:21 -0800 Subject: use argparse and autoprogram for pserve --- docs/pscripts/pserve.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) (limited to 'docs/pscripts') diff --git a/docs/pscripts/pserve.rst b/docs/pscripts/pserve.rst index d33d4a484..991976aea 100644 --- a/docs/pscripts/pserve.rst +++ b/docs/pscripts/pserve.rst @@ -3,11 +3,7 @@ .. _pserve_script: -``pserve`` ----------- - -.. program-output:: pserve --help - :prompt: - :shell: +.. autoprogram:: pyramid.scripts.pserve:PServeCommand.parser + :prog: pserve .. seealso:: :ref:`running_the_project_application` -- cgit v1.2.3 From 5ad647c869c90a6a64fb557d6a28b0d09d7e7354 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 28 Nov 2016 02:10:59 -0800 Subject: use argparse and autoprogram for pshell --- docs/pscripts/pshell.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) (limited to 'docs/pscripts') diff --git a/docs/pscripts/pshell.rst b/docs/pscripts/pshell.rst index cfd84d4f8..4e2ce74cb 100644 --- a/docs/pscripts/pshell.rst +++ b/docs/pscripts/pshell.rst @@ -3,11 +3,7 @@ .. _pshell_script: -``pshell`` ----------- - -.. program-output:: pshell --help - :prompt: - :shell: +.. autoprogram:: pyramid.scripts.pshell:PShellCommand.parser + :prog: pshell .. seealso:: :ref:`interactive_shell` -- cgit v1.2.3 From 7dd4214cccdc417d78a78391cf387ff62489beb0 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 28 Nov 2016 02:15:11 -0800 Subject: use argparse and autoprogram for ptweens --- docs/pscripts/ptweens.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) (limited to 'docs/pscripts') diff --git a/docs/pscripts/ptweens.rst b/docs/pscripts/ptweens.rst index 02e23e49a..f586e1467 100644 --- a/docs/pscripts/ptweens.rst +++ b/docs/pscripts/ptweens.rst @@ -3,11 +3,7 @@ .. _ptweens_script: -``ptweens`` ------------ - -.. program-output:: ptweens --help - :prompt: - :shell: +.. autoprogram:: pyramid.scripts.ptweens:PTweensCommand.parser + :prog: ptweens .. seealso:: :ref:`displaying_tweens` -- cgit v1.2.3 From 812bc62a37205353de1d1719b82718dd0699bf1a Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 28 Nov 2016 02:17:45 -0800 Subject: use argparse and autoprogram for ptviews --- docs/pscripts/pviews.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) (limited to 'docs/pscripts') diff --git a/docs/pscripts/pviews.rst b/docs/pscripts/pviews.rst index b4de5c054..da4660779 100644 --- a/docs/pscripts/pviews.rst +++ b/docs/pscripts/pviews.rst @@ -3,11 +3,7 @@ .. _pviews_script: -``pviews`` ----------- - -.. program-output:: pviews --help - :prompt: - :shell: +.. autoprogram:: pyramid.scripts.pviews:PViewsCommand.parser + :prog: pviews .. seealso:: :ref:`displaying_matching_views` -- cgit v1.2.3