New python swiftclient doc
Updating with new ToC to be worked on at hackathon Change-Id: I55ee83626dd88fcc3e6352b3854b758dd7090590
This commit is contained in:
parent
d2ee01bfe4
commit
f82d26063a
29
doc/source/cli.rst
Normal file
29
doc/source/cli.rst
Normal file
@ -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
|
@ -8,6 +8,8 @@ Developer Documentation
|
||||
:maxdepth: 2
|
||||
|
||||
apis
|
||||
cli
|
||||
sdk
|
||||
|
||||
Code-Generated Documentation
|
||||
============================
|
||||
|
48
doc/source/sdk.rst
Normal file
48
doc/source/sdk.rst
Normal file
@ -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
|
||||
|
Loading…
x
Reference in New Issue
Block a user