rearrange existing content to follow new standard
Change-Id: Ib923265aaab4c001e5313800002aae63b159ec0d Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
parent
8d85b1c9a4
commit
44db83ff0b
|
@ -1,6 +1,6 @@
|
|||
================
|
||||
For Developers
|
||||
================
|
||||
==================
|
||||
For Contributors
|
||||
==================
|
||||
|
||||
If you would like to contribute to cliff directly, these instructions
|
||||
should help you get started. Bug reports, and feature requests are
|
|
@ -1 +0,0 @@
|
|||
.. include:: ../../ChangeLog
|
|
@ -6,22 +6,13 @@ cliff is a framework for building command line programs. It uses
|
|||
plugins to define sub-commands, output formatters, and other
|
||||
extensions.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
introduction
|
||||
demoapp
|
||||
list_commands
|
||||
show_commands
|
||||
complete
|
||||
interactive_mode
|
||||
classes
|
||||
install
|
||||
sphinxext
|
||||
developers
|
||||
history
|
||||
install/index
|
||||
user/index
|
||||
reference/index
|
||||
contributors/index
|
||||
|
||||
|
||||
Indices and tables
|
||||
|
|
|
@ -5,7 +5,7 @@
|
|||
Python Versions
|
||||
===============
|
||||
|
||||
cliff is being developed under Python 2.7 and tested with Python 3.2.
|
||||
cliff is being developed under Python 2.7 and tested with Python 3.5.
|
||||
|
||||
Dependencies
|
||||
============
|
|
@ -1,6 +1,6 @@
|
|||
===============
|
||||
Cliff Classes
|
||||
===============
|
||||
=======================
|
||||
Cliff Class Reference
|
||||
=======================
|
||||
|
||||
Application
|
||||
===========
|
|
@ -81,7 +81,7 @@ main.py
|
|||
|
||||
The main application is defined in ``main.py``:
|
||||
|
||||
.. literalinclude:: ../../demoapp/cliffdemo/main.py
|
||||
.. literalinclude:: ../../../demoapp/cliffdemo/main.py
|
||||
:linenos:
|
||||
|
||||
The :class:`DemoApp` class inherits from :class:`App` and overrides
|
||||
|
@ -116,7 +116,7 @@ simple.py
|
|||
|
||||
Two commands are defined in ``simple.py``:
|
||||
|
||||
.. literalinclude:: ../../demoapp/cliffdemo/simple.py
|
||||
.. literalinclude:: ../../../demoapp/cliffdemo/simple.py
|
||||
:linenos:
|
||||
|
||||
:class:`Simple` demonstrates using logging to emit messages on the
|
||||
|
@ -190,7 +190,7 @@ list.py
|
|||
:class:`cliff.lister.Lister` which prints a list of the files in the
|
||||
current directory.
|
||||
|
||||
.. literalinclude:: ../../demoapp/cliffdemo/list.py
|
||||
.. literalinclude:: ../../../demoapp/cliffdemo/list.py
|
||||
:linenos:
|
||||
|
||||
:class:`Files` prepares the data, and :class:`Lister` manages the
|
||||
|
@ -224,7 +224,7 @@ show.py
|
|||
:class:`cliff.show.ShowOne` which prints the properties of the named
|
||||
file.
|
||||
|
||||
.. literalinclude:: ../../demoapp/cliffdemo/show.py
|
||||
.. literalinclude:: ../../../demoapp/cliffdemo/show.py
|
||||
:linenos:
|
||||
|
||||
:class:`File` prepares the data, and :class:`ShowOne` manages the
|
||||
|
@ -250,7 +250,7 @@ setup.py
|
|||
The demo application is packaged using distribute_, the modern
|
||||
implementation of setuptools.
|
||||
|
||||
.. literalinclude:: ../../demoapp/setup.py
|
||||
.. literalinclude:: ../../../demoapp/setup.py
|
||||
:linenos:
|
||||
|
||||
The important parts of the packaging instructions are the
|
|
@ -0,0 +1 @@
|
|||
.. include:: ../../../ChangeLog
|
|
@ -0,0 +1,15 @@
|
|||
=============
|
||||
Using cliff
|
||||
=============
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
introduction
|
||||
demoapp
|
||||
list_commands
|
||||
show_commands
|
||||
complete
|
||||
interactive_mode
|
||||
sphinxext
|
||||
history
|
Loading…
Reference in New Issue