add initial docs
This commit is contained in:
parent
df7fad8edc
commit
69e92c13db
19 changed files with 878 additions and 30 deletions
57
docs/edbob.commands.rst
Normal file
57
docs/edbob.commands.rst
Normal file
|
@ -0,0 +1,57 @@
|
|||
|
||||
:mod:`edbob.commands`
|
||||
=====================
|
||||
|
||||
.. automodule:: edbob.commands
|
||||
|
||||
.. autofunction:: main
|
||||
|
||||
Base Classes
|
||||
------------
|
||||
|
||||
.. autoclass:: edbob.commands.Command
|
||||
|
||||
.. attribute:: name
|
||||
|
||||
The name for the command. This should match the name of your
|
||||
application.
|
||||
|
||||
.. attribute:: description
|
||||
|
||||
A short description of the command, used when displaying help.
|
||||
|
||||
.. attribute:: long_description
|
||||
|
||||
A longer description of the command, used when displaying help.
|
||||
|
||||
.. attribute:: subcommands
|
||||
|
||||
A dictionary of available subcommands, keyed by name.
|
||||
|
||||
.. attribute:: version
|
||||
|
||||
The version of the application for which the command exists.
|
||||
|
||||
.. automethod:: iter_subcommands
|
||||
|
||||
.. automethod:: print_help
|
||||
|
||||
.. automethod:: run
|
||||
|
||||
.. autoclass:: edbob.commands.Subcommand
|
||||
|
||||
.. autoattribute:: name
|
||||
|
||||
.. autoattribute:: description
|
||||
|
||||
.. automethod:: add_parser_args
|
||||
|
||||
.. automethod:: run
|
||||
|
||||
|
||||
Core Commands
|
||||
-------------
|
||||
|
||||
.. autoclass:: edbob.commands.ShellCommand
|
||||
|
||||
.. autoclass:: edbob.commands.UuidCommand
|
Loading…
Add table
Add a link
Reference in a new issue