blob: 2c432a16fbae48ddc4d9b014299630edf55c3f98 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
|
====
cmd2
====
.. default-domain:: py
.. _cmd: https://docs.python.org/3/library/cmd.html
A python package for building powerful command-line interpreter (CLI)
programs. Extends the Python Standard Library's cmd_ package.
The basic use of ``cmd2`` is identical to that of cmd_.
1. Create a subclass of ``cmd2.Cmd``. Define attributes and
``do_*`` methods to control its behavior. Throughout this documentation,
we will assume that you are naming your subclass ``App``::
from cmd2 import Cmd
class App(Cmd):
# customized attributes and methods here
2. Instantiate ``App`` and start the command loop::
app = App()
app.cmdloop()
Getting Started
===============
.. include:: overview/summary.rst
.. toctree::
:maxdepth: 1
:hidden:
overview/index
Migrating from cmd
==================
.. include:: migrating/summary.rst
.. toctree::
:maxdepth: 2
:hidden:
migrating/index
Features
========
.. toctree::
:maxdepth: 2
features/index
API Reference
=============
.. toctree::
:maxdepth: 2
api/index
Examples
========
.. toctree::
:maxdepth: 2
examples/index
Meta
====
:doc:`doc_conventions`
.. toctree::
:maxdepth: 2
:hidden:
:caption: Meta
doc_conventions
copyright
To Be Integrated
================
Files from old documentation to be integrated into new structure
* :doc:`integrating`
* :doc:`settingchanges`
.. toctree::
:maxdepth: 2
:hidden:
:caption: To Be Integrated
integrating
settingchanges
|
