docs: add basic docs for CLI commands
This commit is contained in:
parent
311a2c328b
commit
be64b4959a
4 changed files with 42 additions and 1 deletions
|
|
@ -21,6 +21,7 @@ extensions = [
|
|||
"sphinx.ext.intersphinx",
|
||||
"sphinx.ext.viewcode",
|
||||
"sphinx.ext.todo",
|
||||
"sphinxcontrib.programoutput",
|
||||
]
|
||||
|
||||
templates_path = ["_templates"]
|
||||
|
|
|
|||
|
|
@ -27,6 +27,7 @@ include:
|
|||
narr/install
|
||||
narr/auth
|
||||
narr/features
|
||||
narr/cli
|
||||
|
||||
|
||||
.. toctree::
|
||||
|
|
|
|||
39
docs/narr/cli.rst
Normal file
39
docs/narr/cli.rst
Normal file
|
|
@ -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
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue