Skip to content

Commit 3f4ab44

Browse files
jmchiltonjmchilton
committed
Update command docs.
1 parent 76d99b9 commit 3f4ab44

File tree

15 files changed

+357
-26
lines changed

15 files changed

+357
-26
lines changed

‎docs/commands.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,16 @@ documentation describes these commands.
1010
.. include:: commands/brew.rst
1111
.. include:: commands/brew_env.rst
1212
.. include:: commands/brew_init.rst
13+
.. include:: commands/conda_env.rst
14+
.. include:: commands/conda_init.rst
15+
.. include:: commands/conda_install.rst
1316
.. include:: commands/config_init.rst
1417
.. include:: commands/cwl_run.rst
1518
.. include:: commands/cwl_script.rst
1619
.. include:: commands/dependency_script.rst
1720
.. include:: commands/docker_build.rst
1821
.. include:: commands/docker_shell.rst
22+
.. include:: commands/docs.rst
1923
.. include:: commands/lint.rst
2024
.. include:: commands/normalize.rst
2125
.. include:: commands/project_init.rst

‎docs/commands/conda_env.rst‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
2+
``conda_env`` command
3+
======================================
4+
5+
This section is auto-generated from the help text for the planemo command
6+
``conda_env``. This help message can be generated with ``planemo conda_env
7+
--help``.
8+
9+
**Usage**::
10+
11+
planemo conda_env [OPTIONS] TOOL_PATH
12+
13+
**Help**
14+
15+
Source output to activate a conda environment for this tool.
16+
17+
% . <(planemo conda_env bowtie2.xml)
18+
% which bowtie2
19+
TODO_PLACE_PATH_HERE
20+
21+
**Options**::
22+
23+
24+
--conda_prefix DIRECTORY Conda prefix to use for conda dependency
25+
commands.
26+
--conda_exec PATH Location of conda executable.
27+
--conda_debug Enable more verbose conda logging.
28+
--conda_ensure_channels TEXT Ensure conda is configured with specified comma
29+
separated list of channels.
30+
--help Show this message and exit.
31+

‎docs/commands/conda_init.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
2+
``conda_init`` command
3+
======================================
4+
5+
This section is auto-generated from the help text for the planemo command
6+
``conda_init``. This help message can be generated with ``planemo conda_init
7+
--help``.
8+
9+
**Usage**::
10+
11+
planemo conda_init [OPTIONS]
12+
13+
**Help**
14+
15+
Download and install conda.
16+
17+
This will download conda for managing dependencies for your platform
18+
using the appropriate Miniconda installer.
19+
20+
By running this command, you are agreeing to the terms of the conda
21+
license a 3-clause BSD 3 license. Please review full license at
22+
http://docs.continuum.io/anaconda/eula.
23+
24+
**Options**::
25+
26+
27+
--conda_prefix DIRECTORY Conda prefix to use for conda dependency
28+
commands.
29+
--conda_exec PATH Location of conda executable.
30+
--conda_debug Enable more verbose conda logging.
31+
--conda_ensure_channels TEXT Ensure conda is configured with specified comma
32+
separated list of channels.
33+
--help Show this message and exit.
34+

‎docs/commands/conda_install.rst‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
2+
``conda_install`` command
3+
======================================
4+
5+
This section is auto-generated from the help text for the planemo command
6+
``conda_install``. This help message can be generated with ``planemo conda_install
7+
--help``.
8+
9+
**Usage**::
10+
11+
planemo conda_install [OPTIONS] TOOL_PATH
12+
13+
**Help**
14+
15+
Install conda packages for tool requirements.
16+
**Options**::
17+
18+
19+
--conda_prefix DIRECTORY Conda prefix to use for conda dependency
20+
commands.
21+
--conda_exec PATH Location of conda executable.
22+
--conda_debug Enable more verbose conda logging.
23+
--conda_ensure_channels TEXT Ensure conda is configured with specified comma
24+
separated list of channels.
25+
--help Show this message and exit.
26+

‎docs/commands/cwl_run.rst‎

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,18 +23,30 @@ Planemo command for running CWL tools and jobs.
2323

2424
--galaxy_root DIRECTORY Root of development galaxy directory to
2525
execute command with.
26-
--galaxy_sqlite_database DIRECTORY
27-
Preseeded Galaxy sqlite database to target.
26+
--galaxy_database_seed PATH Preseeded Galaxy sqlite database to target.
2827
--install_galaxy Download and configure a disposable copy of
2928
Galaxy from github.
29+
--galaxy_branch TEXT Branch of Galaxy to target (defaults to
30+
master) if a Galaxy root isn't specified.
31+
--galaxy_source TEXT Git source of Galaxy to target (defaults to
32+
the official galaxyproject github source if a
33+
Galaxy root isn't specified.
34+
--skip_venv Do not create or source a virtualenv
35+
environment for Galaxy, this should be used or
36+
instance to preserve an externally configured
37+
virtual environment or conda environment.
3038
--no_cache_galaxy Skip caching of Galaxy source and dependencies
3139
obtained with --install_galaxy. Not caching
3240
this results in faster downloads (no git) - so
3341
is better on throw away instances such with
3442
TravisCI.
3543
--no_cleanup Do not cleanup temp files created for and by
3644
Galaxy.
45+
--galaxy_email TEXT E-mail address to use when launching single-
46+
user Galaxy server.
3747
--job_config_file PATH Job configuration file for Galaxy to target.
48+
--tool_dependency_dir DIRECTORY
49+
Tool dependency dir for Galaxy to target.
3850
--port INTEGER Port to serve Galaxy on (default is 9090).
3951
--host TEXT Host to bind Galaxy to. Default is 127.0.0.1
4052
that is restricted to localhost connections
@@ -47,12 +59,42 @@ Planemo command for running CWL tools and jobs.
4759
--dependency_resolvers_config_file PATH
4860
Dependency resolver configuration for Galaxy
4961
to target.
50-
--tool_dependency_dir DIRECTORY
51-
Tool dependency dir for Galaxy to target.
5262
--brew_dependency_resolution Configure Galaxy to use plain brew dependency
5363
resolution.
5464
--shed_dependency_resolution Configure Galaxy to use brewed Tool Shed
5565
dependency resolution.
66+
--conda_prefix DIRECTORY Conda prefix to use for conda dependency
67+
commands.
68+
--conda_exec PATH Location of conda executable.
69+
--conda_debug Enable more verbose conda logging.
70+
--conda_ensure_channels TEXT Ensure conda is configured with specified
71+
comma separated list of channels.
72+
--conda_dependency_resolution Configure Galaxy to use only conda for
73+
dependency resolution.
74+
--conda_copy_dependencies Conda dependency resolution for Galaxy will
75+
copy dependencies instead of attempting to
76+
link them.
77+
--conda_auto_install Conda dependency resolution for Galaxy will
78+
auto install will attempt to install requested
79+
but missing packages.
80+
--conda_auto_init Conda dependency resolution for Galaxy will
81+
auto install conda itself using miniconda if
82+
not availabe on conda_prefix.
83+
--profile TEXT Location of pid file is executed with
84+
--daemon.
85+
--file_path DIRECTORY Location for files created by Galaxy (e.g.
86+
database/files).
87+
--database_connection TEXT Database connection string to use for Galaxy.
88+
--shed_tool_conf TEXT Location of shed tools conf file for Galaxy.
89+
--shed_tool_path TEXT Location of shed tools directory for Galaxy.
90+
--extra_tools PATH Extra tool sources to include in Galaxy's tool
91+
panel (file or directory). These will not be
92+
linted/tested/etc... but they will be
93+
available to workflows and for interactive
94+
use.
95+
--daemon Serve Galaxy process as a daemon.
96+
--pid_file TEXT Location of pid file is executed with
97+
--daemon.
5698
--cwl_galaxy_root DIRECTORY Root of development galaxy directory to
5799
execute command with (must be branch of Galaxy
58100
with CWL support, this option is experimental

‎docs/commands/docker_build.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This section is auto-generated from the help text for the planemo command
1212

1313
**Help**
1414

15-
Builds (and optionally caches Docker images) for tool Dockerfiles.
15+
Build (and optionally cache Docker images) for tool Dockerfiles.
1616

1717
Loads the tool or tools referenced by ``TOOL_PATH`` (by default all tools
1818
in current directory), and ensures they all reference the same Docker image

‎docs/commands/docs.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
``docs`` command
3+
======================================
4+
5+
This section is auto-generated from the help text for the planemo command
6+
``docs``. This help message can be generated with ``planemo docs
7+
--help``.
8+
9+
**Usage**::
10+
11+
planemo docs [OPTIONS]
12+
13+
**Help**
14+
15+
Open the Planemo documentation in a web browser.
16+
**Options**::
17+
18+
19+
--help Show this message and exit.
20+

‎docs/commands/lint.rst‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ This section is auto-generated from the help text for the planemo command
1212

1313
**Help**
1414

15-
Check specified tool(s) for common errors and adherence to best
16-
practices.
17-
15+
Check tools for common errors and adherence to best practices.
1816
**Options**::
1917

2018

‎docs/commands/serve.rst‎

Lines changed: 46 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,18 +39,30 @@ instances.
3939

4040
--galaxy_root DIRECTORY Root of development galaxy directory to
4141
execute command with.
42-
--galaxy_sqlite_database DIRECTORY
43-
Preseeded Galaxy sqlite database to target.
42+
--galaxy_database_seed PATH Preseeded Galaxy sqlite database to target.
4443
--install_galaxy Download and configure a disposable copy of
4544
Galaxy from github.
45+
--galaxy_branch TEXT Branch of Galaxy to target (defaults to
46+
master) if a Galaxy root isn't specified.
47+
--galaxy_source TEXT Git source of Galaxy to target (defaults to
48+
the official galaxyproject github source if a
49+
Galaxy root isn't specified.
50+
--skip_venv Do not create or source a virtualenv
51+
environment for Galaxy, this should be used or
52+
instance to preserve an externally configured
53+
virtual environment or conda environment.
4654
--no_cache_galaxy Skip caching of Galaxy source and dependencies
4755
obtained with --install_galaxy. Not caching
4856
this results in faster downloads (no git) - so
4957
is better on throw away instances such with
5058
TravisCI.
5159
--no_cleanup Do not cleanup temp files created for and by
5260
Galaxy.
61+
--galaxy_email TEXT E-mail address to use when launching single-
62+
user Galaxy server.
5363
--job_config_file PATH Job configuration file for Galaxy to target.
64+
--tool_dependency_dir DIRECTORY
65+
Tool dependency dir for Galaxy to target.
5466
--port INTEGER Port to serve Galaxy on (default is 9090).
5567
--host TEXT Host to bind Galaxy to. Default is 127.0.0.1
5668
that is restricted to localhost connections
@@ -63,12 +75,42 @@ instances.
6375
--dependency_resolvers_config_file PATH
6476
Dependency resolver configuration for Galaxy
6577
to target.
66-
--tool_dependency_dir DIRECTORY
67-
Tool dependency dir for Galaxy to target.
6878
--brew_dependency_resolution Configure Galaxy to use plain brew dependency
6979
resolution.
7080
--shed_dependency_resolution Configure Galaxy to use brewed Tool Shed
7181
dependency resolution.
82+
--conda_prefix DIRECTORY Conda prefix to use for conda dependency
83+
commands.
84+
--conda_exec PATH Location of conda executable.
85+
--conda_debug Enable more verbose conda logging.
86+
--conda_ensure_channels TEXT Ensure conda is configured with specified
87+
comma separated list of channels.
88+
--conda_dependency_resolution Configure Galaxy to use only conda for
89+
dependency resolution.
90+
--conda_copy_dependencies Conda dependency resolution for Galaxy will
91+
copy dependencies instead of attempting to
92+
link them.
93+
--conda_auto_install Conda dependency resolution for Galaxy will
94+
auto install will attempt to install requested
95+
but missing packages.
96+
--conda_auto_init Conda dependency resolution for Galaxy will
97+
auto install conda itself using miniconda if
98+
not availabe on conda_prefix.
99+
--profile TEXT Location of pid file is executed with
100+
--daemon.
101+
--file_path DIRECTORY Location for files created by Galaxy (e.g.
102+
database/files).
103+
--database_connection TEXT Database connection string to use for Galaxy.
104+
--shed_tool_conf TEXT Location of shed tools conf file for Galaxy.
105+
--shed_tool_path TEXT Location of shed tools directory for Galaxy.
106+
--extra_tools PATH Extra tool sources to include in Galaxy's tool
107+
panel (file or directory). These will not be
108+
linted/tested/etc... but they will be
109+
available to workflows and for interactive
110+
use.
111+
--daemon Serve Galaxy process as a daemon.
112+
--pid_file TEXT Location of pid file is executed with
113+
--daemon.
72114
--cwl Configure Galaxy for use with CWL tool. (this
73115
option is experimental and will be replaced
74116
when and if CWL support is merged into

‎docs/commands/shed_lint.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ This section is auto-generated from the help text for the planemo command
1414

1515
Check a Tool Shed repository for common problems.
1616

17-
1817
With the ``--tools`` flag, this command lints actual Galaxy tools
1918
in addition to tool shed artifacts.
2019

0 commit comments

Comments
 (0)