docs: add basic docs for CLI commands

docs/conf.py

@@ -21,6 +21,7 @@ extensions = [
     "sphinx.ext.intersphinx",
     "sphinx.ext.viewcode",
     "sphinx.ext.todo",
+    "sphinxcontrib.programoutput",
 ]
 
 templates_path = ["_templates"]

docs/index.rst

@@ -27,6 +27,7 @@ include:
    narr/install
    narr/auth
    narr/features
+   narr/cli
 
 
 .. toctree::

docs/narr/cli.rst

@@ -0,0 +1,39 @@
+
+========================
+ Command Line Interface
+========================
+
+WuttaFarm ships with the following commands.
+
+For more general info about CLI see
+:doc:`wuttjamaican:narr/cli/index`.
+
+
+.. _wuttafarm-install:
+
+``wuttafarm install``
+---------------------
+
+Run the WuttaFarm app installer.
+
+This will create the :term:`app dir` and initial config files, and
+create the schema within the :term:`app database`.
+
+Defined in: :mod:`wuttafarm.cli.install`
+
+.. program-output:: wuttafarm install --help
+
+
+.. _wuttafarm-import-farmos:
+
+``wuttafarm import-farmos``
+---------------------------
+
+Import data from the farmOS API into the WuttaFarm :term:`app
+database`.
+
+Defined in: :mod:`wuttafarm.cli.import_farmos`
+
+.. program-output:: wuttafarm import-farmos --help
+
+

pyproject.toml

@@ -39,7 +39,7 @@ dependencies = [
 
 
 [project.optional-dependencies]
-docs = ["Sphinx", "furo"]
+docs = ["Sphinx", "furo", "sphinxcontrib-programoutput"]
 
 
 [project.scripts]