feat: add basic "create order" feature, docs, tests
just the package API docs so far, narrative will come later
This commit is contained in:
parent
89265f0240
commit
ef07d30a85
86 changed files with 7749 additions and 35 deletions
43
docs/narr/cli/builtin.rst
Normal file
43
docs/narr/cli/builtin.rst
Normal file
|
@ -0,0 +1,43 @@
|
|||
|
||||
===================
|
||||
Built-in Commands
|
||||
===================
|
||||
|
||||
Sideshow comes with one top-level :term:`command`, and some
|
||||
:term:`subcommands<subcommand>`.
|
||||
|
||||
It uses `Typer`_ for the underlying CLI framework.
|
||||
|
||||
.. _Typer: https://typer.tiangolo.com/
|
||||
|
||||
|
||||
``sideshow``
|
||||
------------
|
||||
|
||||
This is the top-level command. Its purpose is to expose subcommands
|
||||
pertaining to Sideshow.
|
||||
|
||||
It is installed to the virtual environment in the ``bin`` folder (or
|
||||
``Scripts`` on Windows):
|
||||
|
||||
.. code-block:: sh
|
||||
|
||||
cd /path/to/venv
|
||||
bin/sideshow --help
|
||||
|
||||
Defined in: :mod:`sideshow.cli`
|
||||
|
||||
.. program-output:: sideshow --help
|
||||
|
||||
|
||||
.. _sideshow-install:
|
||||
|
||||
``sideshow install``
|
||||
--------------------
|
||||
|
||||
Install the web app, generating config files based on interactive
|
||||
prompting.
|
||||
|
||||
Defined in: :mod:`sideshow.cli.install`
|
||||
|
||||
.. program-output:: sideshow install --help
|
14
docs/narr/cli/index.rst
Normal file
14
docs/narr/cli/index.rst
Normal file
|
@ -0,0 +1,14 @@
|
|||
|
||||
==============
|
||||
Command Line
|
||||
==============
|
||||
|
||||
There isn't much to the command line for Sideshow, but here it is.
|
||||
|
||||
For more general info about CLI see
|
||||
:doc:`wuttjamaican:narr/cli/index`.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
builtin
|
Loading…
Add table
Add a link
Reference in a new issue