diff options
| -rw-r--r-- | docs/source/usage.rst | 4 | ||||
| -rw-r--r-- | docs/source/usage/genopts.rst | 18 | ||||
| -rw-r--r-- | docs/source/usage/list-args.rst | 3 | ||||
| -rw-r--r-- | docs/source/usage/subopts.rst | 17 | ||||
| -rw-r--r-- | src/nncli/__init__.py | 2 |
5 files changed, 23 insertions, 21 deletions
diff --git a/docs/source/usage.rst b/docs/source/usage.rst index f9f3c66..cd81d15 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -1,6 +1,8 @@ Usage ===== +.. _general-options: + .. include:: usage/genopts.rst Subcommands @@ -32,8 +34,6 @@ scripting against your NextCloud Notes database. The subcommands are: These subcommands and the options available to them are described below. -.. _general-options: -.. include:: usage/genopts.rst .. include:: usage/subopts.rst nncli sync diff --git a/docs/source/usage/genopts.rst b/docs/source/usage/genopts.rst index 47c2bfa..9c0e750 100644 --- a/docs/source/usage/genopts.rst +++ b/docs/source/usage/genopts.rst @@ -3,22 +3,24 @@ General Subcommand Options .. program:: nncli -When ``nncli`` is run without any options or arguments an interactive -console GUI will appear. The appearance and behavior of the GUI may be -customized through a configuration file, described elsewhere. +When :program:`nncli` is run without any options or arguments, an +interactive console GUI will appear. The appearance and behavior of +the GUI may be customized through a configuration file, described +elsewhere. In addition to this default behavior, there are several options -available when calling ``nncli`` without a subcommand. +available when calling :program:`nncli` without a subcommand. .. option:: --help, -h -Displays a brief decription of the ``nncli`` options and subcommands. + Displays a brief decription of the :command:`nncli` options and + subcommands. .. option:: --version, -V -Displays the version information. + Displays version information. .. option:: --config, -c -Specify the config file to read from. This option is only required to -override the default location. + Specify the config file to read from. This option is only required + to override the default location. diff --git a/docs/source/usage/list-args.rst b/docs/source/usage/list-args.rst index b3c8ac2..31d242a 100644 --- a/docs/source/usage/list-args.rst +++ b/docs/source/usage/list-args.rst @@ -1,4 +1,3 @@ .. option:: --regex, -r -For subcommands that accept a search string, treat the search string as -a regular expression. + Treat the *search_string* as a regular expression. diff --git a/docs/source/usage/subopts.rst b/docs/source/usage/subopts.rst index 4f7fd44..3a3f976 100644 --- a/docs/source/usage/subopts.rst +++ b/docs/source/usage/subopts.rst @@ -1,23 +1,24 @@ Common Subcommand Options ~~~~~~~~~~~~~~~~~~~~~~~~~ -In addition to the global options, several ``nncli`` options apply to -multiple subcommands. They are: +In addition to the global options, several :command:`nncli` options +apply to multiple subcommands. They are: .. option:: --verbose, -v -Print verbose logging information to ``stdout`` + Print verbose logging information to *stdout*. .. option:: --nosync, -n -Operate only on the local notes cache. Do not reach out to the server. + Operate only on the local notes cache. Do not reach out to the + server. .. option:: --regex, -r -For subcommands that accept a search string, treat the search string as -a regular expression. + For subcommands that accept a search string, treat the search string + as a regular expression. .. option:: --key, -k -The ID of the note to operate on. This option is required for many of -the subcommands. + The ID of the note to operate on. This option is required for many + subcommands. diff --git a/src/nncli/__init__.py b/src/nncli/__init__.py index 0787000..ef9f959 100644 --- a/src/nncli/__init__.py +++ b/src/nncli/__init__.py @@ -1,4 +1,4 @@ # -*- coding: utf-8 -*- """NextCloud Notes Command Line Interface""" -__version__ = '0.3.6' +__version__ = '0.3.7.dev0' |