summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Remove Python 2 support4.0.1anguoming2022-07-071-8/+8
| | | | | | | Python 2 has been deprecated. This patch removes all traces of six, unicode strings and Python 2 tweaks. Change-Id: I74696d02558e0fa93ea1775057db13b4f72aed02
* Switch to newer openstackdocstheme and reno versions3.2.0Andreas Jaeger2020-05-202-18/+7
| | | | | | | | | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents * Fix some rendering problems Update Sphinx version as well. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Set openstackdocs_auto_name to use 'project' as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. Depends-On: https://review.opendev.org/729744 Change-Id: I4c81bec463bb61a559ee8941545c16a08b7041f9
* Ussuri contributor docs community goalJeremy Freudberg2020-04-223-15/+20
| | | | | | | - Updated CONTRIBUTING.rst per goal guidelines - Created doc/source/contributor/contributing.rst per goal guidelines Change-Id: I4a72ec5cec7e48aacc5ce080609fc89f063e7337
* Cleanup py27 supportussuri-em3.1.0Andreas Jaeger2020-04-071-2/+1
| | | | | | | | | | | | | | Make a few cleanups: - Remove python 2.7 stanza from setup.py - Add requires on python >= 3.6 to setup.cfg so that pypi and pip know about the requirement - Remove obsolete sections from setup.cfg: * Wheel is not needed for python 3 only repo * Some other sections are obsolete - Update classifiers - Update requirements, no need for python_version anymore Change-Id: I95a49a2941790e0df1fde38f253ba2516959ce80
* Update sphinx from current requirementsLuigi Toscano2019-06-251-1/+2
| | | | | | Otherwise the requirements-check job fails. Change-Id: I5c3653d41b87869ea3b307206785636274302946
* Fix build with Sphinx 1.7.xThomas Goirand2018-04-251-1/+1
| | | | | | | | | | In sphinx 1.7, the sphinx.util.compat.Directive class doesn't exist anymore, it's available in docutils.parsers.rst.Directive instead, and it was deprecated in Sphinx 1.6 already. This patch makes it therefore work in both version 1.6 and 1.7 just by using the new module path docutils.parsers.rst.Directive. Change-Id: I2e05c1612c687c029174f045d3ea0fec83e1119a
* Updated from global requirementsOpenStack Proposal Bot2018-03-201-0/+3
| | | | Change-Id: Ie139d509497bce763dcaa4293a0bab7cd806d2af
* Follow the new PTI for document buildNguyen Hai2018-03-201-0/+3
| | | | | | | | For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html Change-Id: I616ad9f7f089873890ba508cf3e39067f046ae53
* Migration to StoryboardLuigi Toscano2018-03-173-4/+4
| | | | | | | | Sahara projects migrated to storyboard.openstack.org. Replace the references to Launchpad and clean up some duplication. Fix the bug link in the openstackdocstheme configuration. Change-Id: I01092ad6d35e2c0624646033d95c00526094a06d
* Auto-document members properlyqueens-em1.5.0Jeremy Freudberg2018-01-265-9/+21
| | | | | | | | | | | | | Supporting APIv2 in saharaclient meant that there is now some fancier inheritance going on, so Sphinx :members: now misses a bunch of user-facing methods. Now, start using :inherited-members: to get what we want. Additionally, put the v2 docs under the main reference section instead of in their own section. Change-Id: I56067fe54332497f8d0962986383b74a27d84a76 Closes-Bug: #1745650
* APIv2 support in clientJeremy Freudberg2018-01-254-8/+89
| | | | | | | | | | | | | | | * Support of all APIv2 features carried from APIv1 ("feature parity") * Minimum amount of docs to pass the gate * Endpoint manipulation and version discovery handled by keystoneauth * APIv2 feature: decommision of specific instances (doc change only) * APIv2 feature: force delete (new method) Unit tests will arrive in a future patch. bp v2-api-experimental-impl Co-Authored-By: Monty Taylor <mordred@inaugust.com> Change-Id: I32178439fe85cc6d5faf4ac2e33ae80c08619de5
* Reorganize the documentation following the new structureLuigi Toscano2017-09-048-97/+46
| | | | | | | | | | | | | - move api as "reference" guide and reword as Python client; - consolidate shell and cli as part of the "CLI" guide; - remove the "how_to_participate" page and use part of the content from the old index for a minimal "contributor" guide which redirect to the sahara contributor guide (no need to duplicate the information); - remove few references to doc/source/api from tox.ini and .gitignore (for some reason the directory was cleaned). Change-Id: Iff049ab32a7695a7a58bd370a1517b1ed7d2f048
* Update and optimize documentation linksHangdong Zhang2017-07-184-10/+10
| | | | | | | | 1. Update URLs according to document migration 2. Update the dead links 3. Optimize (e.g. http -> https) Change-Id: Ib66107d24a5171676a73cde7ead487bef259a5d5
* doc: migrate to openstackdocsthemeLuigi Toscano2017-07-131-14/+8
| | | | | Both doc/ and releasenotes/ Change-Id: Ic9a5d593053364e8b10f022b53cb0ab2587431b0
* doc: enable warning-is-error and fix warningsLuigi Toscano2017-07-131-1/+1
| | | | | | | A small workaround is required for a specific parameter (see the inline comment). Change-Id: I1eac60cc8ca89a12dd568f5a12f70fdab9b76b62
* Fix html_last_updated_fmt for Python3Vu Cong Tuan2017-06-041-2/+1
| | | | | | | | | html_last_updated_fmt option is interpreted as a byte string in python3, causing Sphinx build to break. This patch makes it utf-8 string. Change-Id: I9b23a0dfadaa195bc22ee7f8b8da0c0c9a0e6052 Closes-Bug:#1693670
* Fix doc build if git is absentThomas Bechtold2016-08-311-2/+7
| | | | | | | | | When building packages if git is absent, then we should not set html_last_updated_fmt. It can still be set via the -D switch when building with sphinx-build. Change-Id: Ie6477df7f65e5035b1b03b51f698972ce9dd9aaa Closes-Bug: #1552251
* avoid additional requirement for building docsVitaly Gridnev2016-06-163-1/+525
| | | | | | | DocImpact Change-Id: I2d4dda2ee6fdfcf82702f4400a2513e7aa83957d closes-bug: 1551292
* Remove unused pngmath Sphinx extensionAndreas Jaeger2016-02-291-1/+1
| | | | | | | | There's no RST file that uses ".. math" and thus the pngmath Sphinx extension is not used and can get removed. Change-Id: I3ea4b529025c8ac3c4092f3720124647861e6668
* Merge "Keystoneclient to keystoneauth migration"0.12.0Jenkins2016-02-141-4/+4
|\
| * Keystoneclient to keystoneauth migrationMichael Ionkin2016-02-111-4/+4
| | | | | | | | | | | | | | | | | | | | Keystoneauth was extracted from keystoneclient so we need to migrate to keystoneauth also deleted get_projects_list method because it is not used Change-Id: I2c611d6b5ae08eacc11513e0dd2548e42b9dc828 bp: keystoneclient-to-keystoneauth
* | Replace deprecated library function os.popen() with subprocessting.wang2016-01-131-2/+5
|/ | | | | | | | os.popen() is deprecated since python 2.6. Resolved with use of subprocess module Change-Id: I4b6469bf17a26389bcc6d844140a14f45896b9ff Closes-Bug: #1529836
* Merge "Adding sphinx extension for CLI docs autogeneration"Jenkins2015-11-266-2/+161
|\
| * Adding sphinx extension for CLI docs autogenerationAndrey Pavlov2015-11-126-2/+161
| | | | | | | | | | | | | | | | | | New CLI docs now can be autogenerated, that prevents them from being outdated and excludes manual updates Partially implements: blueprint cli-as-openstackclient-plugin Change-Id: I11e6dadc7d19bd55777e748e7ada199311b20003
* | Adding autogenerated saharaclient API docsAndrey Pavlov2015-11-121-56/+47
|/ | | | | | | | Saharaclient API docs now can be autogenerated, that prevents them from manual update. Also docstrings were added to describe some unclear parameters. Change-Id: Ibf9fdf332c91cdfb18d6f8ec5429a39dc2862494
* Adding Sahara CLI overview to docs and fixing warningsAndrey Pavlov2015-11-123-4/+65
| | | | | | | | | | New Sahara CLI as OpenStackClient plugin usage overview added and few warnings during docs generation fixed Partially implements: blueprint cli-as-openstackclient-plugin Change-Id: If5b4608429d994c642237d6a73ebd9e1bd985fc5 Closes-bug: #1512690
* Updating saharaclient api docsAndrey Pavlov2015-09-071-44/+46
| | | | Change-Id: Ia8795962ab81e66efbf4e7a3f48eeee0c5aa6ecc
* Add how to participate docSergey Lukjanov2015-02-112-0/+70
| | | | | | | We have a separated doc for client, so, we need to replicate how to participate doc too. Change-Id: I73d9e5cb83a672915cf0110771ae6f79f5f47436
* Workflow documentation is now in infra-manualJeremy Stanley2014-12-051-1/+1
| | | | | | | Replace URLs for workflow documentation to appropriate parts of the OpenStack Project Infrastructure Manual. Change-Id: I772fb66bfb25664e88530675dfb95291d407d992
* Replacing data_processing with data-processingTelles Nobrega2014-11-181-1/+1
| | | | | | | | Using data_processing causes a problem when defining the endpoint statically in keystone. Change-Id: I8fb2be802c4390bdcd49e1722cd36f50781b1feb Partial-bug: #1356053
* Support Cinder availability zonesAdrien Vergé2014-10-121-1/+1
| | | | | Change-Id: I2bfdc46a49942498d43032aef5ed6c4b076933e4 Implements: blueprint support-cinder-availability-zones
* Support Nova availability zonesAdrien Vergé2014-10-081-1/+1
| | | | | Change-Id: Ie0812b70f50f971cf7099a85c9809733eff1599f Implements: blueprint support-nova-availability-zones
* updating link to Sahara docsMichael McCune2014-07-151-1/+1
| | | | | | | | Changes * removed /api/index.html from the doc link in index.rst Change-Id: I4f28db365243be5260b88d4451b18e580d48d0d3 Closes-Bug: #1342242
* Merge "Swap the saharaclient and savannaclient directories"Jenkins2014-03-141-11/+11
|\
| * Swap the saharaclient and savannaclient directoriesTrevor McKay2014-03-131-11/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Exchange the contents of the saharaclient and savannaclient directories so that 'savannlient' is the effective alias and 'saharaclient' contains all of the source code. * Change all of the imports that reference savannaclient to saharaclient * Change paths that reference savannaclient (under doc) * Leave variable and class names unchaned at this point * Leave references to python_savannaclient unchanged since the top * level dir name has not yet changed Partial-implements: blueprint savanna-renaming-client Change-Id: I83cb21922ae5a8cec291990b3ab67bb9e3cb2d62
* | Change client doc references to saharaTrevor McKay2014-03-133-51/+51
|/ | | | | Partial-implements: blueprint savanna-renaming-client Change-Id: I72f943db56a9c9c85bad1cd10ea9cd34fddf471c
* Move client docs to the clientSergey Lukjanov2014-02-186-0/+499
It contains new index doc file with general notes and links to other docs. Change-Id: I9805b9afedccf510dd2a4aca2716a9336da0d357
View Lorry Controller Status