Merge "move existing content into the new standard structure"

doc/source/cli/index.rst

@@ -0,0 +1,26 @@
+=============================
+ Command-line Tool Reference
+=============================
+
+In order to use the CLI, you must provide your OpenStack username,
+password, tenant, and auth endpoint. Use the corresponding
+configuration options (``--os-username``, ``--os-password``,
+``--os-tenant-id``, and ``--os-auth-url``) or set them in environment
+variables::
+
+    export OS_USERNAME=user
+    export OS_PASSWORD=pass
+    export OS_TENANT_ID=b363706f891f48019483f8bd6503c54b
+    export OS_AUTH_URL=http://auth.example.com:5000/v2.0
+
+The command line tool will attempt to reauthenticate using your
+provided credentials for every request. You can override this behavior
+by manually supplying an auth token using ``--os-solum-url`` and
+``--os-auth-token``. You can alternatively set these environment
+variables::
+
+    export OS_SOLUM_URL=http://solum.example.org:9777/
+    export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
+
+Once you've configured your authentication parameters, you can run
+``solum help`` to see a complete listing of available commands.

doc/source/index.rst

@@ -1,16 +1,12 @@
-Welcome to python-solumclient's documentation!
-==============================================
+================================
+python-solumclient documentation
+================================
 
-Contents:
+This is a client for the OpenStack Application Lifecycle Management API.
+There's a Python API (the :mod:`solumclient` module) and a command-line
+script (installed as :program:`solum`).
 
 .. toctree::
    :maxdepth: 2
 
-   readme
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   cli/index

doc/source/readme.rst

@@ -1 +0,0 @@
-.. include:: ../../README.rst