diff options
| author | kotfu <kotfu@kotfu.net> | 2019-07-06 12:51:55 -0600 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2019-07-06 12:51:55 -0600 |
| commit | 369f7eb1df01cc46e0212aa131536e99c1fa68ba (patch) | |
| tree | 0026f840c81396fa03cba3f647e09d099dcc2b85 /docs/overview | |
| parent | 52a670483e2ea010c56debb4c1ad51c9fda05e46 (diff) | |
| download | cmd2-git-369f7eb1df01cc46e0212aa131536e99c1fa68ba.tar.gz | |
Work on Getting Started section of documentation
- change the walk through from example.py to a new first_app.py (based on example.py)
- remove the feature tour section, we’ll use the first application to demo the key features
Diffstat (limited to 'docs/overview')
| -rw-r--r-- | docs/overview/featuretour.rst | 5 | ||||
| -rw-r--r-- | docs/overview/index.rst | 3 | ||||
| -rw-r--r-- | docs/overview/summary.rst | 4 |
3 files changed, 2 insertions, 10 deletions
diff --git a/docs/overview/featuretour.rst b/docs/overview/featuretour.rst deleted file mode 100644 index a0d33da4..00000000 --- a/docs/overview/featuretour.rst +++ /dev/null @@ -1,5 +0,0 @@ -Feature Highlights -================== - -[Briefly describe the list of major features, linking to the more detailed description -of each features elsewhere in the documentation.] diff --git a/docs/overview/index.rst b/docs/overview/index.rst index 831e9bf0..231191c1 100644 --- a/docs/overview/index.rst +++ b/docs/overview/index.rst @@ -5,9 +5,8 @@ Getting Started :maxdepth: 1 :hidden: - featuretour - ../examples/example installation + ../examples/first_app integrating alternatives resources diff --git a/docs/overview/summary.rst b/docs/overview/summary.rst index 17d4732d..b59c86c2 100644 --- a/docs/overview/summary.rst +++ b/docs/overview/summary.rst @@ -11,11 +11,9 @@ want to add more functionality with very little work? ``cmd2`` is a powerful python library for building command line applications. Start here to find out if this library is a good fit for your needs. -* :ref:`overview/featuretour:Feature Highlights` - a quick tour of a few of the - features in ``cmd2``, for both developers and users -* :ref:`examples/example:Simple Application` - a sample application showing 5 key features of ``cmd2`` * :ref:`overview/installation:Installation Instructions` - how to install ``cmd2`` and associated optional dependencies +* :ref:`examples/first_app:First Application` - a sample application showing 8 key features of ``cmd2`` * :ref:`overview/integrating:Integrate cmd2 Into Your Project` - adding ``cmd2`` to your project * :ref:`overview/alternatives:Alternatives` - other python packages that might |