docs: describing the commands

The commands is lacking from the documentation.

docs/commands.rst

@@ -0,0 +1,36 @@
+.. _commands:
+
+Commands
+--------
+
+.. _cmd-changelog:
+
+changelog
+^^^^^^^^^
+When executed this command will generate/update ``CHANGELOG.txt``.
+
+
+.. _cmd-publish:
+
+publish
+^^^^^^^
+Publish will do a sequence of things.
+
+#. Run same as the :ref:`cmd-version` command
+#. Push changes to git
+#. If ``upload_to_pypi`` is not ``false`` in the :ref:`configuration`
+   it will create the wheel and upload to pypi using twine.
+#. If the environment variable ``GH_TOKEN`` (or equivalent for your
+   vcs provider) is set then :ref:`cmd-changelog` will be executed and
+   the changelog will be posted to your vcs provider if that is supported.
+
+
+.. _cmd-version:
+
+version
+^^^^^^^
+This will only figure out the new version number using
+:ref:`commit-log-parsing`, and commit + tag in git.
+
+This will not push anything to any remote. All changes
+are local.

docs/index.rst

@@ -34,13 +34,20 @@ ignored. Running release can be run locally or from a CI service.
       --retry  Retry the same release, do not bump.
       --help   Show this message and exit.
 
+    Commands:
+      changelog  Generates the changelog since the last...
+      publish    Runs the version task before pushing to git...
+      version    Detects the new version according to git log...
+
+
 Documentation Contents:
 =======================
 
 .. toctree::
    :maxdepth: 1
 
    Quickstart <../readme>
+   Commands <commands>
    Parsing of commit logs <commit-log-parsing>
    Automatic releases <automatic-releases/index>
    Configuration <configuration>