Skip to content

Commit

Permalink
Updated usage docs. Rebuilt and reformatted all RST docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mwvaughn
mwvaughn committed Apr 23, 2021
1 parent 8bd60e0 commit 54c5325
Show file tree
Hide file tree
Showing 74 changed files with 126 additions and 163 deletions.
30 changes: 9 additions & 21 deletions docs/configure/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,30 +36,18 @@ One may view the current settings for the Tapis CLI:
Configuration options can be set using ``tapis config set``.

**********
An Example
**********
**************
Usage Examples
**************

The number of results returned from list-type commands is defined by the
variable ``TAPIS_CLI_PAGE_SIZE`` and defaults to **50**. List-type commands
support a ``--limit`` option, which will be used if specified. If no option
is passed, the CLI will look for variable ``TAPIS_CLI_PAGE_SIZE`` in the shell
environment then in a ``.env`` file. Here are ways to configure the page size:
**Setting the page size for list results**: The number of results returned from
list-type commands is defined by the variable ``TAPIS_CLI_PAGE_SIZE`` and
defaults to **50**. List-type commands support a ``--limit`` option, which
will be used if specified. If no option is passed, the CLI will look for
variable ``TAPIS_CLI_PAGE_SIZE`` in the shell environment then in an
``.env`` file. Here are ways to configure the page size:

- Dynamically, via argument: ``tapis apps list --limit 10``
- Dynamically, via variable: ``TAPIS_CLI_PAGE_SIZE=10 tapis apps list``
- For the current shell: ``export TAPIS_CLI_PAGE_SIZE=10``
- For all future usage: ``tapis apps set TAPIS_CLI_PAGE_SIZE 10``

*****************
Some Key Settings
*****************

*Coming soon*

*****************
Technical Details
*****************

*Coming soon*

13 changes: 13 additions & 0 deletions docs/introduction/release-notes.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@ require you to change your existing workflows or usage patterns. The exception
to this is when we add entirely new commands or functions (such as
integration with GitHub or the like).

**************************
1.0.4 (04-30-2021)
**************************

Added
-----

Changed
-------

Removed
-------

**************************
1.0.0 (06-16-2020)
**************************
Expand Down
5 changes: 0 additions & 5 deletions docs/introduction/roadmap.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,6 @@ Planned major features for Tapis CLI are outlined below. Please click the link
and comment / thumbs-up the corresponding GitHub issue if a feature is a
priority for you.

****************************************
Support for Abaco Functions-as-a-Service
****************************************
(Github issue)

***********************
Integration with GitHub
***********************
Expand Down
Empty file removed docs/introduction/why-tapis-cli.rst
View file
Empty file.
6 changes: 3 additions & 3 deletions docs/projects/app_ini.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@ a project corresponds to a single container repo.
| use_commit_hash | Use current commit hash as tag |
+-----------------+-------------------------------------+

Env
===
Environment
===========

This is a special section where you, the end-user, can add custom
option-value pairs for use by the CLI templating engine. Option
Expand All @@ -87,7 +87,7 @@ Bad option names:
Values must be simple scalars and it should be assumed they will be
interpreted as strings.

Using Env in a File
Using Environment in a File
-------------------

Here is an example of including a custom option ``value123`` and using it
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ tacc-cookiecutter
tenacity
validators
#git+https://github.com/TACC/agavepy.git@1_0_0
agavepy==1.0.0a10
agavepy==1.0.0a11
flake8
pytest==4.6.5 # pinned for Python 2.7.x support
pytest-cov
Expand Down
1 change: 0 additions & 1 deletion docs/source/tapis_cli.clients.basic.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ tapis\_cli.clients.basic.main module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.clients.nonce.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ tapis\_cli.clients.nonce.main module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.clients.oauth.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,3 @@ tapis\_cli.clients.oauth.refresh module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.clients.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,3 @@ tapis\_cli.clients.http module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.clients.services.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,3 @@ tapis\_cli.clients.services.mixins module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.clients.services.taccapis.v2.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,3 @@ tapis\_cli.clients.services.taccapis.v2.format\_one module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.local.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,3 @@ tapis\_cli.commands.local.versions module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.local.settings.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,3 @@ tapis\_cli.commands.local.settings.unset module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.model.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,3 @@ tapis\_cli.commands.taccapis.model.base module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.model.v2.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,3 @@ tapis\_cli.commands.taccapis.model.v2.username module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,3 @@ tapis\_cli.commands.taccapis.searchable module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.actors.deploy.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,3 @@ tapis\_cli.commands.taccapis.v2.actors.deploy.rcfile module
:members:
:undoc-members:
:show-inheritance:

26 changes: 26 additions & 0 deletions docs/source/tapis_cli.commands.taccapis.v2.actors.init.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
tapis\_cli.commands.taccapis.v2.actors.init package
===================================================

.. automodule:: tapis_cli.commands.taccapis.v2.actors.init
:members:
:undoc-members:
:show-inheritance:

Submodules
----------

tapis\_cli.commands.taccapis.v2.actors.init.init module
-------------------------------------------------------

.. automodule:: tapis_cli.commands.taccapis.v2.actors.init.init
:members:
:undoc-members:
:show-inheritance:

tapis\_cli.commands.taccapis.v2.actors.init.templates module
------------------------------------------------------------

.. automodule:: tapis_cli.commands.taccapis.v2.actors.init.templates
:members:
:undoc-members:
:show-inheritance:
1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.actors.manage.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,3 @@ tapis\_cli.commands.taccapis.v2.actors.manage.update module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.actors.models.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,3 @@ tapis\_cli.commands.taccapis.v2.actors.models.worker module
:members:
:undoc-members:
:show-inheritance:

18 changes: 17 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.actors.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Subpackages

tapis_cli.commands.taccapis.v2.actors.deploy
tapis_cli.commands.taccapis.v2.actors.helpers
tapis_cli.commands.taccapis.v2.actors.init
tapis_cli.commands.taccapis.v2.actors.manage
tapis_cli.commands.taccapis.v2.actors.models

Expand Down Expand Up @@ -52,6 +53,14 @@ tapis\_cli.commands.taccapis.v2.actors.aliases\_show module
:undoc-members:
:show-inheritance:

tapis\_cli.commands.taccapis.v2.actors.aliases\_update module
-------------------------------------------------------------

.. automodule:: tapis_cli.commands.taccapis.v2.actors.aliases_update
:members:
:undoc-members:
:show-inheritance:

tapis\_cli.commands.taccapis.v2.actors.delete module
----------------------------------------------------

Expand Down Expand Up @@ -84,6 +93,14 @@ tapis\_cli.commands.taccapis.v2.actors.execs\_show module
:undoc-members:
:show-inheritance:

tapis\_cli.commands.taccapis.v2.actors.execs\_stop module
---------------------------------------------------------

.. automodule:: tapis_cli.commands.taccapis.v2.actors.execs_stop
:members:
:undoc-members:
:show-inheritance:

tapis\_cli.commands.taccapis.v2.actors.formatters module
--------------------------------------------------------

Expand Down Expand Up @@ -227,4 +244,3 @@ tapis\_cli.commands.taccapis.v2.actors.workers\_show module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.apim.gitserver.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ tapis\_cli.commands.taccapis.v2.apim.gitserver.init module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.apim.models.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ tapis\_cli.commands.taccapis.v2.apim.models.token module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.apim.registry.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ tapis\_cli.commands.taccapis.v2.apim.registry.init module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.apim.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,3 @@ tapis\_cli.commands.taccapis.v2.apim.token\_refresh module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.apps.deploy.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ tapis\_cli.commands.taccapis.v2.apps.deploy.deploy module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.apps.helpers.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ tapis\_cli.commands.taccapis.v2.apps.helpers.pems module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.apps.init.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,3 @@ tapis\_cli.commands.taccapis.v2.apps.init.templates module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.apps.models.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,3 @@ tapis\_cli.commands.taccapis.v2.apps.models.app\_history module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.apps.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,4 +163,3 @@ tapis\_cli.commands.taccapis.v2.apps.update module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.files.helpers.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,3 @@ tapis\_cli.commands.taccapis.v2.files.helpers.walk module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.files.models.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,3 @@ tapis\_cli.commands.taccapis.v2.files.models.file\_staging module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.files.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,4 +145,3 @@ tapis\_cli.commands.taccapis.v2.files.upload module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.jobs.helpers.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,3 @@ tapis\_cli.commands.taccapis.v2.jobs.helpers.walk module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.jobs.init.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,3 @@ tapis\_cli.commands.taccapis.v2.jobs.init.job module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.jobs.models.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,3 @@ tapis\_cli.commands.taccapis.v2.jobs.models.job\_pem module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.jobs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,4 +178,3 @@ tapis\_cli.commands.taccapis.v2.jobs.unhide module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.metadata.helpers.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,3 @@ tapis\_cli.commands.taccapis.v2.metadata.helpers.name module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.metadata.models.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ tapis\_cli.commands.taccapis.v2.metadata.models.metadata module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.metadata.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,3 @@ tapis\_cli.commands.taccapis.v2.metadata.update module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.notifications.models.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ tapis\_cli.commands.taccapis.v2.notifications.models.notification module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.notifications.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,3 @@ tapis\_cli.commands.taccapis.v2.notifications.update module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.postits.models.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ tapis\_cli.commands.taccapis.v2.postits.models.postit module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.postits.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,3 @@ tapis\_cli.commands.taccapis.v2.postits.mixins module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.profiles.models.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ tapis\_cli.commands.taccapis.v2.profiles.models.profile module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.profiles.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,3 @@ tapis\_cli.commands.taccapis.v2.profiles.show\_self module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,3 @@ tapis\_cli.commands.taccapis.v2.pem module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.systems.models.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,3 @@ tapis\_cli.commands.taccapis.v2.systems.models.system\_role module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.commands.taccapis.v2.systems.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,4 +184,3 @@ tapis\_cli.commands.taccapis.v2.systems.update module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.et.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,3 @@ tapis\_cli.et.phone\_home module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.hashcache.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,3 @@ tapis\_cli.hashcache.picklecache module
:members:
:undoc-members:
:show-inheritance:

1 change: 0 additions & 1 deletion docs/source/tapis_cli.project_ini.mixins.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,3 @@ tapis\_cli.project\_ini.mixins.app module
:members:
:undoc-members:
:show-inheritance:

0 comments on commit 54c5325

Please sign in to comment.