summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/source/apis.rst6
-rw-r--r--doc/source/cli.rst29
-rw-r--r--doc/source/index.rst2
-rw-r--r--doc/source/sdk.rst48
4 files changed, 82 insertions, 3 deletions
diff --git a/doc/source/apis.rst b/doc/source/apis.rst
index 1a8e8f7..6545554 100644
--- a/doc/source/apis.rst
+++ b/doc/source/apis.rst
@@ -1,6 +1,6 @@
-============
-Introduction
-============
+======================
+python-swiftclient API
+======================
The python-swiftclient includes two levels of API; a low level client API that
provides simple python wrappers around the various authentication mechanisms
diff --git a/doc/source/cli.rst b/doc/source/cli.rst
new file mode 100644
index 0000000..9527fbf
--- /dev/null
+++ b/doc/source/cli.rst
@@ -0,0 +1,29 @@
+===
+CLI
+===
+
+Top-level commands
+~~~~~~~~~~~~~~~~~~
+
+.. TODO
+
+ delete
+ download
+ list
+ post
+ stat
+ upload
+ info/capabilities
+ tempurl
+ auth
+
+Prescriptive examples
+~~~~~~~~~~~~~~~~~~~~~
+
+.. TODO
+
+ A "Hello World" example
+ uploading an object
+ creating a tempurl
+ listing the contents of a container
+ downloading an object \ No newline at end of file
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 3b8535a..da16a3c 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -8,6 +8,8 @@ Developer Documentation
:maxdepth: 2
apis
+ cli
+ sdk
Code-Generated Documentation
============================
diff --git a/doc/source/sdk.rst b/doc/source/sdk.rst
new file mode 100644
index 0000000..aa15250
--- /dev/null
+++ b/doc/source/sdk.rst
@@ -0,0 +1,48 @@
+===
+SDK
+===
+
+Where to start?
+~~~~~~~~~~~~~~~
+
+.. TODO
+
+ when to use SwiftService
+ when to use client.py
+
+SwiftService classes and methods
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. TODO
+
+ docs for each method (autogen from docstrings?)
+
+Client classes and methods
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. TODO
+
+ docs for each method (autogen from docstrings?)
+
+Guidelines for writing an app
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. TODO
+
+ auth
+ how to use various features
+ when to use various features
+ pooling connections
+ concurrency
+ retries
+
+Prescriptive examples
+~~~~~~~~~~~~~~~~~~~~~
+
+.. TODO
+
+ A "Hello World" example
+ connecting
+ uploading an object
+ uploading a directory
+ \ No newline at end of file