Diff
from v0.3.6 to v0.3.7
Diffstat
CHANGELOG.rst | 32 ++++++++++++++------------------
docs/source/usage.rst | 4 ++--
docs/source/usage/genopts.rst | 18 ++++++++++--------
docs/source/usage/list-args.rst | 3 +--
docs/source/usage/subopts.rst | 17 +++++++++--------
src/nncli/__init__.py | 2 +-
CHANGELOG.rst
| 6 |
6 |
The format is based on `Keep a Changelog`_, and this project adheres to |
| 7 |
7 |
`Semantic Versioning`_. |
| 8 |
8 |
|
| 9 |
|
-`Unreleased`_ |
|
9 |
+`v0.3.7`_ - 2023-10-16 |
| 10 |
10 |
------------- |
| 11 |
11 |
Changed |
| 12 |
|
- |
| 13 |
|
-Added |
| 14 |
|
- |
| 15 |
|
-Fixed |
| 16 |
|
- |
| 17 |
|
-Removed |
|
12 |
+ - Updated links in CHANGELOG due to Git host backend change |
|
13 |
+ - Other documentation updates |
| 18 |
14 |
|
| 19 |
15 |
`v0.3.6`_ - 2022-12-30 |
| 20 |
16 |
---------------------- |
|
|
. . . |
| 148 |
144 |
|
| 149 |
145 |
.. _Keep a Changelog: https://keepachangelog.com/en/1.0.0/ |
| 150 |
146 |
.. _Semantic Versioning: https://semver.org/spec/v2.0.0.html |
| 151 |
|
-.. _Unreleased: https://git.danielmoch.com/nncli/diff/?id=master&id2=v0.3.6 |
| 152 |
|
-.. _v0.3.6: https://git.danielmoch.com/nncli/diff/?id=v0.3.6&id2=v0.3.5 |
| 153 |
|
-.. _v0.3.5: https://git.danielmoch.com/nncli/diff/?id=v0.3.5&id2=v0.3.4 |
| 154 |
|
-.. _v0.3.4: https://git.danielmoch.com/nncli/diff/?id=v0.3.4&id2=v0.3.3 |
| 155 |
|
-.. _v0.3.3: https://git.danielmoch.com/nncli/diff/?id=v0.3.3&id2=v0.3.2 |
| 156 |
|
-.. _v0.3.2: https://git.danielmoch.com/nncli/diff/?id=v0.3.2&id2=v0.3.1 |
| 157 |
|
-.. _v0.3.1: https://git.danielmoch.com/nncli/diff/?id=v0.3.1&id2=v0.3.0 |
| 158 |
|
-.. _v0.3.0: https://git.danielmoch.com/nncli/diff/?id=v0.3.0&id2=v0.2.0 |
| 159 |
|
-.. _v0.2.0: https://git.danielmoch.com/nncli/diff/?id=v0.2.0&id2=v0.1.2 |
| 160 |
|
-.. _v0.1.2: https://git.danielmoch.com/nncli/diff/?id=v0.1.2&id2=v0.1.1 |
| 161 |
|
-.. _v0.1.1: https://git.danielmoch.com/nncli/diff/?id=v0.1.1&id2=v0.1.0 |
|
147 |
+.. _v0.3.7: https://git.danielmoch.com/nncli/diff/v0.3.6..v0.3.7 |
|
148 |
+.. _v0.3.6: https://git.danielmoch.com/nncli/diff/v0.3.5..v0.3.6 |
|
149 |
+.. _v0.3.5: https://git.danielmoch.com/nncli/diff/v0.3.4..v0.3.5 |
|
150 |
+.. _v0.3.4: https://git.danielmoch.com/nncli/diff/v0.3.3..v0.3.4 |
|
151 |
+.. _v0.3.3: https://git.danielmoch.com/nncli/diff/v0.3.2..v0.3.3 |
|
152 |
+.. _v0.3.2: https://git.danielmoch.com/nncli/diff/v0.3.1..v0.3.2 |
|
153 |
+.. _v0.3.1: https://git.danielmoch.com/nncli/diff/v0.3.0..v0.3.1 |
|
154 |
+.. _v0.3.0: https://git.danielmoch.com/nncli/diff/v0.2.0..v0.3.0 |
|
155 |
+.. _v0.2.0: https://git.danielmoch.com/nncli/diff/v0.1.2..v0.2.0 |
|
156 |
+.. _v0.1.2: https://git.danielmoch.com/nncli/diff/v0.1.1..v0.1.2 |
|
157 |
+.. _v0.1.1: https://git.danielmoch.com/nncli/diff/v0.1.0..v0.1.1 |
docs/source/usage.rst
| 1 |
1 |
Usage |
| 2 |
2 |
===== |
| 3 |
3 |
|
|
4 |
+.. _general-options: |
|
5 |
+ |
| 4 |
6 |
.. include:: usage/genopts.rst |
| 5 |
7 |
|
| 6 |
8 |
Subcommands |
|
|
. . . |
| 32 |
34 |
|
| 33 |
35 |
These subcommands and the options available to them are described below. |
| 34 |
36 |
|
| 35 |
|
-.. _general-options: |
| 36 |
|
-.. include:: usage/genopts.rst |
| 37 |
37 |
.. include:: usage/subopts.rst |
| 38 |
38 |
|
| 39 |
39 |
nncli sync |
docs/source/usage/genopts.rst
| 3 |
3 |
|
| 4 |
4 |
.. program:: nncli |
| 5 |
5 |
|
| 6 |
|
-When ``nncli`` is run without any options or arguments an interactive |
| 7 |
|
-console GUI will appear. The appearance and behavior of the GUI may be |
| 8 |
|
-customized through a configuration file, described elsewhere. |
|
6 |
+When :program:`nncli` is run without any options or arguments, an |
|
7 |
+interactive console GUI will appear. The appearance and behavior of |
|
8 |
+the GUI may be customized through a configuration file, described |
|
9 |
+elsewhere. |
| 9 |
10 |
|
| 10 |
11 |
In addition to this default behavior, there are several options |
| 11 |
|
-available when calling ``nncli`` without a subcommand. |
|
12 |
+available when calling :program:`nncli` without a subcommand. |
| 12 |
13 |
|
| 13 |
14 |
.. option:: --help, -h |
| 14 |
15 |
|
| 15 |
|
-Displays a brief decription of the ``nncli`` options and subcommands. |
|
16 |
+ Displays a brief decription of the :command:`nncli` options and |
|
17 |
+ subcommands. |
| 16 |
18 |
|
| 17 |
19 |
.. option:: --version, -V |
| 18 |
20 |
|
| 19 |
|
-Displays the version information. |
|
21 |
+ Displays version information. |
| 20 |
22 |
|
| 21 |
23 |
.. option:: --config, -c |
| 22 |
24 |
|
| 23 |
|
-Specify the config file to read from. This option is only required to |
| 24 |
|
-override the default location. |
|
25 |
+ Specify the config file to read from. This option is only required |
|
26 |
+ to override the default location. |
docs/source/usage/list-args.rst
| 1 |
1 |
.. option:: --regex, -r |
| 2 |
2 |
|
| 3 |
|
-For subcommands that accept a search string, treat the search string as |
| 4 |
|
-a regular expression. |
|
3 |
+ Treat the *search_string* as a regular expression. |
docs/source/usage/subopts.rst
| 1 |
1 |
Common Subcommand Options |
| 2 |
2 |
~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 3 |
3 |
|
| 4 |
|
-In addition to the global options, several ``nncli`` options apply to |
| 5 |
|
-multiple subcommands. They are: |
|
4 |
+In addition to the global options, several :command:`nncli` options |
|
5 |
+apply to multiple subcommands. They are: |
| 6 |
6 |
|
| 7 |
7 |
.. option:: --verbose, -v |
| 8 |
8 |
|
| 9 |
|
-Print verbose logging information to ``stdout`` |
|
9 |
+ Print verbose logging information to *stdout*. |
| 10 |
10 |
|
| 11 |
11 |
.. option:: --nosync, -n |
| 12 |
12 |
|
| 13 |
|
-Operate only on the local notes cache. Do not reach out to the server. |
|
13 |
+ Operate only on the local notes cache. Do not reach out to the |
|
14 |
+ server. |
| 14 |
15 |
|
| 15 |
16 |
.. option:: --regex, -r |
| 16 |
17 |
|
| 17 |
|
-For subcommands that accept a search string, treat the search string as |
| 18 |
|
-a regular expression. |
|
18 |
+ For subcommands that accept a search string, treat the search string |
|
19 |
+ as a regular expression. |
| 19 |
20 |
|
| 20 |
21 |
.. option:: --key, -k |
| 21 |
22 |
|
| 22 |
|
-The ID of the note to operate on. This option is required for many of |
| 23 |
|
-the subcommands. |
|
23 |
+ The ID of the note to operate on. This option is required for many |
|
24 |
+ subcommands. |
src/nncli/__init__.py
| 1 |
1 |
# -*- coding: utf-8 -*- |
| 2 |
2 |
"""NextCloud Notes Command Line Interface""" |
| 3 |
3 |
|
| 4 |
|
-__version__ = '0.3.6' |
|
4 |
+__version__ = '0.3.7' |