openstack/python-swiftclient
Code Issues Proposed changes
f1858d89e0
python-swiftclient/doc/source/index.rst

57 lines
1.1 KiB
ReStructuredText
Raw Normal View History

Add new doc structure and contents for swiftclient As a result of the Hackathon we have produced a new documentation structure for the python-swiftclient. This patch introduces the new structure and adds the required content. The intention is to document the CLI, the SwiftService and Connection API. Importantly, we also provide guidance on important considerations when using a swift object store, such as which aspect of the python-swiftclient to use for various use cases, common authentication patterns and some useful examples. Co-Authored-By: Alexandra Settle <alexandra.settle@rackspace.com> Co-Authored-By: Mohit Motiani <mohit.motiani@intel.com> Co-Authored-By: Hisashi Osanai <osanai.hisashi@jp.fujitsu.com> Change-Id: I9eb41f8e9137efa66cead67dc264a76a3c03fbda
2016-03-03 17:22:33 +00:00
======================================
New API documentation for python-swiftclient New documentation for python-swiftclient that introduces the APIs available and gives some opinionated advice about when to use the shell, the client API and the service API. Change-Id: I19020f041fab2e72469979f712ffe3951c431d24
2015-06-08 15:19:11 +01:00
Welcome to the python-swiftclient Docs
Add new doc structure and contents for swiftclient As a result of the Hackathon we have produced a new documentation structure for the python-swiftclient. This patch introduces the new structure and adds the required content. The intention is to document the CLI, the SwiftService and Connection API. Importantly, we also provide guidance on important considerations when using a swift object store, such as which aspect of the python-swiftclient to use for various use cases, common authentication patterns and some useful examples. Co-Authored-By: Alexandra Settle <alexandra.settle@rackspace.com> Co-Authored-By: Mohit Motiani <mohit.motiani@intel.com> Co-Authored-By: Hisashi Osanai <osanai.hisashi@jp.fujitsu.com> Change-Id: I9eb41f8e9137efa66cead67dc264a76a3c03fbda
2016-03-03 17:22:33 +00:00
======================================
Introduction
~~~~~~~~~~~~
.. toctree::
:maxdepth: 2
introduction
Add doc and version in swiftclient.__init__.py - Add parseable version in swiftclient.__init.py - Generate rst doc like done for swift. Change-Id: I408fbc36693772d2ef6f4823757dd1f4c830193f
2012-05-23 15:14:47 +02:00
New API documentation for python-swiftclient New documentation for python-swiftclient that introduces the APIs available and gives some opinionated advice about when to use the shell, the client API and the service API. Change-Id: I19020f041fab2e72469979f712ffe3951c431d24
2015-06-08 15:19:11 +01:00
Developer Documentation
Add new doc structure and contents for swiftclient As a result of the Hackathon we have produced a new documentation structure for the python-swiftclient. This patch introduces the new structure and adds the required content. The intention is to document the CLI, the SwiftService and Connection API. Importantly, we also provide guidance on important considerations when using a swift object store, such as which aspect of the python-swiftclient to use for various use cases, common authentication patterns and some useful examples. Co-Authored-By: Alexandra Settle <alexandra.settle@rackspace.com> Co-Authored-By: Mohit Motiani <mohit.motiani@intel.com> Co-Authored-By: Hisashi Osanai <osanai.hisashi@jp.fujitsu.com> Change-Id: I9eb41f8e9137efa66cead67dc264a76a3c03fbda
2016-03-03 17:22:33 +00:00
~~~~~~~~~~~~~~~~~~~~~~~
Add doc and version in swiftclient.__init__.py - Add parseable version in swiftclient.__init.py - Generate rst doc like done for swift. Change-Id: I408fbc36693772d2ef6f4823757dd1f4c830193f
2012-05-23 15:14:47 +02:00
New API documentation for python-swiftclient New documentation for python-swiftclient that introduces the APIs available and gives some opinionated advice about when to use the shell, the client API and the service API. Change-Id: I19020f041fab2e72469979f712ffe3951c431d24
2015-06-08 15:19:11 +01:00
.. toctree::
:maxdepth: 2
Add doc and version in swiftclient.__init__.py - Add parseable version in swiftclient.__init.py - Generate rst doc like done for swift. Change-Id: I408fbc36693772d2ef6f4823757dd1f4c830193f
2012-05-23 15:14:47 +02:00
Ussuri contrib docs community goal This patch standardizes the CONTRIBUTING.rst file and adds the required doc/source/contributor/contributing.rst The contibuting.txt points to the Swift contributor documentation. Change-Id: Ia6c105698dd0269479536645270d12a7c1061bc7
2020-05-13 15:36:22 +10:00
contributor/contributing
moved cli doc to the right place for new links process Change-Id: I5d2f681ba5ce1f95d006eb7208cdb388a64811c9
2017-07-26 13:47:59 -07:00
cli/index
Add new doc structure and contents for swiftclient As a result of the Hackathon we have produced a new documentation structure for the python-swiftclient. This patch introduces the new structure and adds the required content. The intention is to document the CLI, the SwiftService and Connection API. Importantly, we also provide guidance on important considerations when using a swift object store, such as which aspect of the python-swiftclient to use for various use cases, common authentication patterns and some useful examples. Co-Authored-By: Alexandra Settle <alexandra.settle@rackspace.com> Co-Authored-By: Mohit Motiani <mohit.motiani@intel.com> Co-Authored-By: Hisashi Osanai <osanai.hisashi@jp.fujitsu.com> Change-Id: I9eb41f8e9137efa66cead67dc264a76a3c03fbda
2016-03-03 17:22:33 +00:00
service-api
client-api
Add doc and version in swiftclient.__init__.py - Add parseable version in swiftclient.__init.py - Generate rst doc like done for swift. Change-Id: I408fbc36693772d2ef6f4823757dd1f4c830193f
2012-05-23 15:14:47 +02:00
Code-Generated Documentation
Add new doc structure and contents for swiftclient As a result of the Hackathon we have produced a new documentation structure for the python-swiftclient. This patch introduces the new structure and adds the required content. The intention is to document the CLI, the SwiftService and Connection API. Importantly, we also provide guidance on important considerations when using a swift object store, such as which aspect of the python-swiftclient to use for various use cases, common authentication patterns and some useful examples. Co-Authored-By: Alexandra Settle <alexandra.settle@rackspace.com> Co-Authored-By: Mohit Motiani <mohit.motiani@intel.com> Co-Authored-By: Hisashi Osanai <osanai.hisashi@jp.fujitsu.com> Change-Id: I9eb41f8e9137efa66cead67dc264a76a3c03fbda
2016-03-03 17:22:33 +00:00
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Add doc and version in swiftclient.__init__.py - Add parseable version in swiftclient.__init.py - Generate rst doc like done for swift. Change-Id: I408fbc36693772d2ef6f4823757dd1f4c830193f
2012-05-23 15:14:47 +02:00
.. toctree::
:maxdepth: 2
swiftclient
Indices and tables
Add new doc structure and contents for swiftclient As a result of the Hackathon we have produced a new documentation structure for the python-swiftclient. This patch introduces the new structure and adds the required content. The intention is to document the CLI, the SwiftService and Connection API. Importantly, we also provide guidance on important considerations when using a swift object store, such as which aspect of the python-swiftclient to use for various use cases, common authentication patterns and some useful examples. Co-Authored-By: Alexandra Settle <alexandra.settle@rackspace.com> Co-Authored-By: Mohit Motiani <mohit.motiani@intel.com> Co-Authored-By: Hisashi Osanai <osanai.hisashi@jp.fujitsu.com> Change-Id: I9eb41f8e9137efa66cead67dc264a76a3c03fbda
2016-03-03 17:22:33 +00:00
~~~~~~~~~~~~~~~~~~
Add doc and version in swiftclient.__init__.py - Add parseable version in swiftclient.__init.py - Generate rst doc like done for swift. Change-Id: I408fbc36693772d2ef6f4823757dd1f4c830193f
2012-05-23 15:14:47 +02:00
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
New API documentation for python-swiftclient New documentation for python-swiftclient that introduces the APIs available and gives some opinionated advice about when to use the shell, the client API and the service API. Change-Id: I19020f041fab2e72469979f712ffe3951c431d24
2015-06-08 15:19:11 +01:00
License
Add new doc structure and contents for swiftclient As a result of the Hackathon we have produced a new documentation structure for the python-swiftclient. This patch introduces the new structure and adds the required content. The intention is to document the CLI, the SwiftService and Connection API. Importantly, we also provide guidance on important considerations when using a swift object store, such as which aspect of the python-swiftclient to use for various use cases, common authentication patterns and some useful examples. Co-Authored-By: Alexandra Settle <alexandra.settle@rackspace.com> Co-Authored-By: Mohit Motiani <mohit.motiani@intel.com> Co-Authored-By: Hisashi Osanai <osanai.hisashi@jp.fujitsu.com> Change-Id: I9eb41f8e9137efa66cead67dc264a76a3c03fbda
2016-03-03 17:22:33 +00:00
~~~~~~~
New API documentation for python-swiftclient New documentation for python-swiftclient that introduces the APIs available and gives some opinionated advice about when to use the shell, the client API and the service API. Change-Id: I19020f041fab2e72469979f712ffe3951c431d24
2015-06-08 15:19:11 +01:00
docs: Clean up formatting Change-Id: I0bcaf15c54dd3b3c590a543569699fe8ec5b0c7c
2019-03-25 09:35:47 -07:00
Copyright 2013 OpenStack, LLC.
New API documentation for python-swiftclient New documentation for python-swiftclient that introduces the APIs available and gives some opinionated advice about when to use the shell, the client API and the service API. Change-Id: I19020f041fab2e72469979f712ffe3951c431d24
2015-06-08 15:19:11 +01:00
docs: Clean up formatting Change-Id: I0bcaf15c54dd3b3c590a543569699fe8ec5b0c7c
2019-03-25 09:35:47 -07:00
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
New API documentation for python-swiftclient New documentation for python-swiftclient that introduces the APIs available and gives some opinionated advice about when to use the shell, the client API and the service API. Change-Id: I19020f041fab2e72469979f712ffe3951c431d24
2015-06-08 15:19:11 +01:00
docs: Clean up formatting Change-Id: I0bcaf15c54dd3b3c590a543569699fe8ec5b0c7c
2019-03-25 09:35:47 -07:00
* http://www.apache.org/licenses/LICENSE-2.0
New API documentation for python-swiftclient New documentation for python-swiftclient that introduces the APIs available and gives some opinionated advice about when to use the shell, the client API and the service API. Change-Id: I19020f041fab2e72469979f712ffe3951c431d24
2015-06-08 15:19:11 +01:00
docs: Clean up formatting Change-Id: I0bcaf15c54dd3b3c590a543569699fe8ec5b0c7c
2019-03-25 09:35:47 -07:00
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
New API documentation for python-swiftclient New documentation for python-swiftclient that introduces the APIs available and gives some opinionated advice about when to use the shell, the client API and the service API. Change-Id: I19020f041fab2e72469979f712ffe3951c431d24
2015-06-08 15:19:11 +01:00
Copy Permalink