summaryrefslogtreecommitdiff
path: root/doc/source/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* PDF Documentation Build tox targetMatthew Oliver2019-09-041-1/+3
| | | | | | | | | | | This patch adds a `pdf-docs` tox target that will build PDF versions of our docs. As per the Train community goal: https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html Story: 2006122 Task: 35514 Change-Id: I7e0ee410ac603774e4b03f859ac3aa20e5afc9b8
* Bump the openstackdocstheme extension to 1.20pengyuesheng2019-07-031-9/+0
| | | | | | | | | | | | Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_engine - latex_elements - version - release. Change-Id: I0573c7feaea991e6b33bdee6dc358c9206a9bfd8
* Switch from oslosphinx to openstackdocsthemeNguyen Hai2018-05-231-3/+6
| | | | | | | | openstackdocstheme is a theme and extension support for Sphinx documentation that is published to docs.openstack.org and developer.openstack.org. Change-Id: I37d1d50fb88b35e72b017d5dfbf148c35ac7e323
* Merge "Add v1password keystoneauth plugin"Jenkins2016-11-081-1/+1
|\
| * Add v1password keystoneauth pluginTim Burke2016-10-241-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This lets us use Keystone sessions against endpoints like swauth and tempauth with code like: import keystoneauth1.loading import keystoneauth1.session import swiftclient loader = keystoneauth1.loading.get_plugin_loader('v1password') auth_plugin = loader.load_from_options( auth_url='http://saio:8080/auth/v1.0', username='test:tester', password='testing') keystone_session = keystoneauth1.session.Session(auth_plugin) conn = swiftclient.Connection(session=keystone_session) The plugin includes an optional project_name option, which may be used to override the swift account from the storage url that was returned. Additionally, it includes enough infrastructure to support some commands in python-openstackclient>=3.0: export OS_AUTH_TYPE=v1password export OS_AUTH_URL=http://saio:8080/auth/v1.0 export OS_PROJECT_NAME=AUTH_test2 export OS_USERNAME=test:tester export OS_PASSWORD=testing openstack token issue openstack catalog list openstack catalog show object-store openstack object store account show openstack container list openstack container create <container> openstack container save <container> openstack container show <container> openstack container delete <container> openstack object list <container> openstack object create <container> <file> openstack object save <container> <object> opsentack object show <container> <object> openstack object delete <container> <object> Change-Id: Ia963dc44415f72a6518227e86d9528a987e07491
* | reenable sidebar linksJohn Dickinson2016-08-111-0/+2
|/ | | | | | uses new method from https://review.openstack.org/#/c/340509/ Change-Id: I4d19b71b632546fc2e5d5dac2b0d8d43152dabed
* Update theme for docsSteve Martinelli2014-07-241-2/+2
| | | | | | | | The current developer docs theme used is out of sync with the other openstack projects. This patch will update the docs to provide a more consistent look and feel when using developer docs Change-Id: I2c66f60f6cfdd7b7b50a457c931f11851f668fa6
* fixed several pep8 issuesChristian Berendt2014-05-211-34/+34
| | | | | | | | | | | * E111 indentation is not a multiple of four * E128 continuation line under-indented for visual indent * E265 block comment should start with '# ' * E713 test for membership should be 'not in' Tested with pep8 version 1.5.6 (2014-04-14). Change-Id: I7f85c143d463c501a0df20724362ad5c0f2d4dde
* Make pbr only a build-time dependency.Samuel Merritt2013-10-101-3/+3
| | | | | | | | | | | | | | This lets you build python-swiftclient packages that don't require pbr to be installed at all. You would need pbr on the machine running rpmbuild / debuild, but not on the machines that install the packages. Unfortunately, this does not make python-swiftclient able to be installed via pip 0.3.1 on Lucid; you'll need to uninstall the system python-pip package and install a new pip some other way. Given that pip < 1.3 doesn't perform SSL certificate validation for pypi (trivial MITM attack, anyone?), you'd probably want to get a new pip anyway. Change-Id: I85d4d77aacf094e48d39e48e750594b95dbc7af0
* Move multi-threading code to a library.Darrell Bishop2013-07-281-3/+4
| | | | | | | | | | | | | | | | | | | | | | This patch extracts the multi-threading code from bin/swift into swiftclient/multithreading and adds tests. In particular, this new way of doing it (with context managers) will prevent non-daemonic threads from wedging the process when unexpected exceptions happen. I enabled reporting of which lines, specifically, are not covered by unit tests (added -m option to "coverage report" in .unittests). This patch includes a drive-by fix for uploading a segmented file with --use-slo when that object already exists. A key of "name" was used instead of "path", raising KeyError. There's also another drive-by fix for uploading segmented objects with --use-slo. Commit 874e0e4427b80e1b15b74a1557b73ba9d61443ca regressed this by removing the capturing of thread-worker results in QueueFunctionThread.run(). This patch restores that functionality and the feature (uploading SLO objects). Change-Id: I0b4f677e4a734e83d1a25088d9a74f7d46384e53
* Update to latest oslo version/setup.Monty Taylor2013-01-141-3/+1
| | | | Change-Id: I7bd38b950ef9fea8b6eaa1df599085a1c64d8b61
* PEP8 issues fixedRay Chen2012-08-291-3/+5
| | | | | | | 1. Have a better indent in doc/source/conf.py 2. Fix an import issue Change-Id: I5811c195157706d2a85c0fd47666e67f94b2c558
* Fix PEP8 issues.lrqrun2012-08-281-1/+2
| | | | | | Fix some pep8 issues in doc/source/conf.py make the code looks pretty. Change-Id: Icc5ce260aaae8a2c436f5146840ffde4e6ef2839
* Merge "Removes the title "Swift Web" from landing page."Jenkins2012-07-161-1/+1
|\
| * Removes the title "Swift Web" from landing page.annegentle2012-07-051-1/+1
| | | | | | | | | | | | Also want to test the DocImpact flag for notifications. Change-Id: I4e12d76050720bec5126db3c87391dbbe54773a2
* | Consume version info from pkg_resources.Clark Boylan2012-07-111-3/+4
|/ | | | | | | | | | | | | | Documenation builds specify a version in doc/source/conf.py that is used in appropriate places through out the documentation. Previously this value had not been defined properly and documentation builds failed. Retrieve the version info using pkg_resources and set it properly. Use openstack.common.version to consume the generated version information for documentation. Additional, add a swiftclient.__version__ member which will return the version of swiftclient being used. Change-Id: I14f3abdf00da3f9ea7d0651efe76b08f69ddabae
* Add build_sphinx options.Clark Boylan2012-06-111-1/+8
| | | | | | | | | To better facilitate the building and publishing of sphinx documentation by Jenkins we are moving all openstack projects with sphinx documentation to a common doc tree structure. Documentation goes in project/doc/source and build results go in project/doc/build. Change-Id: Ibe6745cac73817ea06faca77367b4269d5137a24
* Add doc and version in swiftclient.__init__.pyChmouel Boudjnah2012-06-071-0/+197
- Add parseable version in swiftclient.__init.py - Generate rst doc like done for swift. Change-Id: I408fbc36693772d2ef6f4823757dd1f4c830193f
View Lorry Controller Status