diff --git a/doc/source/developers.rst b/doc/source/contributors/index.rst similarity index 97% rename from doc/source/developers.rst rename to doc/source/contributors/index.rst index 8eb4b34b..185c4fb3 100644 --- a/doc/source/developers.rst +++ b/doc/source/contributors/index.rst @@ -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 diff --git a/doc/source/history.rst b/doc/source/history.rst deleted file mode 100644 index 69ed4fe6..00000000 --- a/doc/source/history.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../ChangeLog diff --git a/doc/source/index.rst b/doc/source/index.rst index 68a8227a..c9d1b47d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 diff --git a/doc/source/install.rst b/doc/source/install/index.rst similarity index 99% rename from doc/source/install.rst rename to doc/source/install/index.rst index 30a99450..ec55f650 100644 --- a/doc/source/install.rst +++ b/doc/source/install/index.rst @@ -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 ============ diff --git a/doc/source/classes.rst b/doc/source/reference/index.rst similarity index 91% rename from doc/source/classes.rst rename to doc/source/reference/index.rst index 14e80e93..5b67aa18 100644 --- a/doc/source/classes.rst +++ b/doc/source/reference/index.rst @@ -1,6 +1,6 @@ -=============== - Cliff Classes -=============== +======================= + Cliff Class Reference +======================= Application =========== diff --git a/doc/source/complete.rst b/doc/source/user/complete.rst similarity index 100% rename from doc/source/complete.rst rename to doc/source/user/complete.rst diff --git a/doc/source/demoapp.rst b/doc/source/user/demoapp.rst similarity index 96% rename from doc/source/demoapp.rst rename to doc/source/user/demoapp.rst index 2f328da7..9dd7b8a4 100644 --- a/doc/source/demoapp.rst +++ b/doc/source/user/demoapp.rst @@ -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 diff --git a/doc/source/user/history.rst b/doc/source/user/history.rst new file mode 100644 index 00000000..f69be70b --- /dev/null +++ b/doc/source/user/history.rst @@ -0,0 +1 @@ +.. include:: ../../../ChangeLog diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 00000000..19fa3970 --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,15 @@ +============= + Using cliff +============= + +.. toctree:: + :maxdepth: 2 + + introduction + demoapp + list_commands + show_commands + complete + interactive_mode + sphinxext + history diff --git a/doc/source/interactive_mode.rst b/doc/source/user/interactive_mode.rst similarity index 100% rename from doc/source/interactive_mode.rst rename to doc/source/user/interactive_mode.rst diff --git a/doc/source/introduction.rst b/doc/source/user/introduction.rst similarity index 100% rename from doc/source/introduction.rst rename to doc/source/user/introduction.rst diff --git a/doc/source/list_commands.rst b/doc/source/user/list_commands.rst similarity index 100% rename from doc/source/list_commands.rst rename to doc/source/user/list_commands.rst diff --git a/doc/source/show_commands.rst b/doc/source/user/show_commands.rst similarity index 100% rename from doc/source/show_commands.rst rename to doc/source/user/show_commands.rst diff --git a/doc/source/sphinxext.rst b/doc/source/user/sphinxext.rst similarity index 100% rename from doc/source/sphinxext.rst rename to doc/source/user/sphinxext.rst