diff options
author | Jenkins <jenkins@review.openstack.org> | 2016-02-22 20:31:15 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2016-02-22 20:31:15 +0000 |
commit | 689ce4738dd196ec5f22b9a6ec7c90e75502667a (patch) | |
tree | e207aa4bfb16d90691045014349d244d8c04506b | |
parent | da0aa24f28da8508283da85b6a45e29912a927cf (diff) | |
parent | f82d26063a3d0515886ac9f62ba0c60fe125aa54 (diff) | |
download | python-swiftclient-689ce4738dd196ec5f22b9a6ec7c90e75502667a.tar.gz |
Merge "New python swiftclient doc"
-rw-r--r-- | doc/source/cli.rst | 29 | ||||
-rw-r--r-- | doc/source/index.rst | 2 | ||||
-rw-r--r-- | doc/source/sdk.rst | 48 |
3 files changed, 79 insertions, 0 deletions
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 |