diff --git a/bloom/commands/generate.py b/bloom/commands/generate.py index 166caaa8..b8931905 100644 --- a/bloom/commands/generate.py +++ b/bloom/commands/generate.py @@ -72,11 +72,15 @@ def create_subparsers(parser, generator_cmds): add_global_arguments(cmd_parser) -def main(sysargs=None): - parser = argparse.ArgumentParser( +def get_argument_parser(): + return argparse.ArgumentParser( description="Calls a generator on a local package, e.g. bloom-generate debian" ) + +def main(sysargs=None): + parser = get_argument_parser() + generator_cmds = list_generator_commands() create_subparsers(parser, generator_cmds) diff --git a/docs/conf.py b/docs/conf.py index b2f4ff45..9abd8f83 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,7 +19,7 @@ # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) +sys.path.insert(0, os.path.abspath('..')) # -- General configuration ------------------------------------------------ @@ -35,6 +35,7 @@ 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', + 'sphinxarg.ext', ] # Add any paths that contain templates here, relative to this directory. @@ -146,7 +147,7 @@ # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +#html_static_path = [] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/docs/index.rst b/docs/index.rst index d341e823..df93bbba 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -49,3 +49,11 @@ How do I release something with bloom? --------------------------------------- Please refer to the documentation and tutorials on the bloom_ ROS wiki page. + +.. toctree:: + :caption: Command Details + :glob: + :hidden: + :maxdepth: 2 + + scripts/* diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..1e76fdad --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +sphinx-argparse \ No newline at end of file diff --git a/docs/scripts/bloom-export-upstream.rst b/docs/scripts/bloom-export-upstream.rst new file mode 100644 index 00000000..17558332 --- /dev/null +++ b/docs/scripts/bloom-export-upstream.rst @@ -0,0 +1,6 @@ +bloom-export-upstream +===================== + +.. argparse:: + :ref: bloom.commands.export_upstream.get_argument_parser + :prog: bloom-export-upstream diff --git a/docs/scripts/bloom-generate.rst b/docs/scripts/bloom-generate.rst new file mode 100644 index 00000000..1427aa47 --- /dev/null +++ b/docs/scripts/bloom-generate.rst @@ -0,0 +1,6 @@ +bloom-generate +============== + +.. argparse:: + :ref: bloom.commands.generate.get_argument_parser + :prog: bloom-generate diff --git a/docs/scripts/bloom-release.rst b/docs/scripts/bloom-release.rst new file mode 100644 index 00000000..5275ee8c --- /dev/null +++ b/docs/scripts/bloom-release.rst @@ -0,0 +1,6 @@ +bloom-release +============= + +.. argparse:: + :ref: bloom.commands.release.get_argument_parser + :prog: bloom-release diff --git a/docs/scripts/bloom-update.rst b/docs/scripts/bloom-update.rst new file mode 100644 index 00000000..64edf70c --- /dev/null +++ b/docs/scripts/bloom-update.rst @@ -0,0 +1,6 @@ +bloom-update +============ + +.. argparse:: + :ref: bloom.commands.update.get_argument_parser + :prog: bloom-update diff --git a/docs/scripts/git-bloom-branch.rst b/docs/scripts/git-bloom-branch.rst new file mode 100644 index 00000000..71f02744 --- /dev/null +++ b/docs/scripts/git-bloom-branch.rst @@ -0,0 +1,6 @@ +git-bloom-branch +================ + +.. argparse:: + :ref: bloom.commands.git.branch.get_parser + :prog: git-bloom-branch diff --git a/docs/scripts/git-bloom-config.rst b/docs/scripts/git-bloom-config.rst new file mode 100644 index 00000000..dd328595 --- /dev/null +++ b/docs/scripts/git-bloom-config.rst @@ -0,0 +1,6 @@ +git-bloom-config +================ + +.. argparse:: + :ref: bloom.commands.git.config.get_argument_parser + :prog: git-bloom-config \ No newline at end of file diff --git a/docs/scripts/git-bloom-generate.rst b/docs/scripts/git-bloom-generate.rst new file mode 100644 index 00000000..5cd58a1f --- /dev/null +++ b/docs/scripts/git-bloom-generate.rst @@ -0,0 +1,6 @@ +git-bloom-generate +================== + +.. argparse:: + :ref: bloom.commands.git.generate.get_parser + :prog: git-bloom-generate diff --git a/docs/scripts/git-bloom-import-upstream.rst b/docs/scripts/git-bloom-import-upstream.rst new file mode 100644 index 00000000..8af81d95 --- /dev/null +++ b/docs/scripts/git-bloom-import-upstream.rst @@ -0,0 +1,6 @@ +git-bloom-import-upstream +========================= + +.. argparse:: + :ref: bloom.commands.git.import_upstream.get_argument_parser + :prog: git-bloom-import-upstream diff --git a/docs/scripts/git-bloom-patch.rst b/docs/scripts/git-bloom-patch.rst new file mode 100644 index 00000000..3239c2cd --- /dev/null +++ b/docs/scripts/git-bloom-patch.rst @@ -0,0 +1,6 @@ +git-bloom-patch +=============== + +.. argparse:: + :ref: bloom.commands.git.patch.patch_main.get_argument_parser + :prog: git-bloom-patch \ No newline at end of file diff --git a/docs/scripts/git-bloom-rebase.rst b/docs/scripts/git-bloom-rebase.rst new file mode 100644 index 00000000..123b6564 --- /dev/null +++ b/docs/scripts/git-bloom-rebase.rst @@ -0,0 +1,2 @@ +git-bloom-rebase +================