summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Add Designate hacking checks to the clientMichael Johnson2021-11-291-2/+3
| | | | | | | | | | This patch adds the Designate hacking checks to also run against the Designate client code to maintain consistent style checking across the Designate repositories. It also resolves one style check failure. Change-Id: I09786482b2e7fecaa3d4484c9b1a017fae04cfea
* Stop to use the __future__ module.Hervé Beraud2021-11-233-3/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | The __future__ module [1] was used in this context to ensure compatibility between python 2 and python 3. We previously dropped the support of python 2.7 [2] and now we only support python 3 so we don't need to continue to use this module and the imports listed below. Imports commonly used and their related PEPs: - `division` is related to PEP 238 [3] - `print_function` is related to PEP 3105 [4] - `unicode_literals` is related to PEP 3112 [5] - `with_statement` is related to PEP 343 [6] - `absolute_import` is related to PEP 328 [7] [1] https://docs.python.org/3/library/__future__.html [2] https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html [3] https://www.python.org/dev/peps/pep-0238 [4] https://www.python.org/dev/peps/pep-3105 [5] https://www.python.org/dev/peps/pep-3112 [6] https://www.python.org/dev/peps/pep-0343 [7] https://www.python.org/dev/peps/pep-0328 Change-Id: I3dadeaa3242d0b55ba891a8eb4abb199a8d2468b
* Add auto generated OSC documentationMichael Johnson2020-10-134-4/+53
| | | | | | | This patch adds OpenStack client documentation that is auto generated using cliff. Change-Id: I7fb7414c268e6413ee7f21fccd7a045ba7f8418c
* Fix doc reference buildsmichaeltchapman2020-10-133-2/+17
| | | | | | | | | | | The api reference was broken some time around the stein release. Moved conf options out of setup.cfg and into the doc conf.py, and added an option to doc build to error on warnings so this doesn't happen again without anyone noticing. The format is now similar to the novaclient reference doc. Change-Id: Ic9ed059521794acf1ac1a644096fdc10549fa91b
* Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-212-18/+7
| | | | | | | | | | | | | | | | | | | | | | | Switch to openstackdocstheme 2.2.0 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. 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. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I6bac230569a89c055115c852d5cc0cae027cddd8
* Cleanup py27 supportussuri-em4.0.0Andreas Jaeger2020-04-042-3/+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 - Remove html_last_updated_fmt from conf.py, this is not needed with openstackdocstheme anymore; update openstackdocstheme requirement Change-Id: I5389ba08c985e023643c07adf3135809c291146f
* More cleanupJens Harbott2019-09-172-6/+8
| | | | | | | | - Add .testrepository dir to .gitignore - Add releasenote jobs - Remove further v1 references from docs Change-Id: I178185e9add3d542277255d692e18a8e46ba85d6
* Removing v1 api supporttrain-em3.0.0Erik Olof Gunnar Andersson2019-09-1014-1894/+36
| | | | | | | The v1 has officially been removed from Designate since the Queens release, and was deperecated long before that. Change-Id: Ic5b44761ff939e2b319924af87849b3a79f9cb07
* Cap sphinx for py2 to match global requirementszhangboye2019-06-061-1/+2
| | | | Change-Id: I619cdb572dec1fc599e445aca07349b31cb16738
* Trivial: Update pypi url to new urlmelissaml2018-04-211-1/+1
| | | | | | | | | Pypi url changed from [1] to [2] [1] https://pypi.python.org/pypi/<package> [2] https://pypi.org/project/<package> Change-Id: I49bb581c87d28bebe9f251cec801eaf5b79606d7
* Updated from global requirementsOpenStack Proposal Bot2018-03-151-1/+1
| | | | Change-Id: Ia58a4bc1b168dd9b57f59231cbaa0e35071e0a85
* Updated from global requirementsOpenStack Proposal Bot2018-03-131-1/+1
| | | | Change-Id: I95d293d674e9e8f93488c85d2f1a8018670fe693
* Updated from global requirementsOpenStack Proposal Bot2018-03-101-1/+1
| | | | Change-Id: Ie98183968ec570097a18632a417bce7bc04911c7
* Merge "Highlight V1 API removal"Zuul2018-02-281-0/+7
|\
| * Highlight V1 API removalGraham Hayes2018-02-121-0/+7
| | | | | | | | | | | | | | Update Docs and the execption logged to point users to the openstack cli + v2 client. Change-Id: Ib08330d348a6a2f0e976ab0df26e91b2d7bd4e13
* | Updated from global requirementsqueens-em2.9.0OpenStack Proposal Bot2018-01-241-1/+1
| | | | | | | | Change-Id: Ic6c3f0454bcc103d583e28c49c2d7fdbc7aa5816
* | Updated from global requirementsOpenStack Proposal Bot2018-01-181-1/+1
|/ | | | Change-Id: I273c1bef643207929cbd5733d93ebf999d3e7132
* Updated from global requirementsOpenStack Proposal Bot2017-12-191-0/+3
| | | | Change-Id: Ie5e0096cdd95eb58ff07b2b3f1d6c0bdde3a4eae
* Split doc requirements into their own fileMonty Taylor2017-12-181-0/+2
| | | | | | | | We don't need sphinx in the test virtualenvs, but we do need it for docs. Change-Id: I8ae98d08090e2e391ba725ddd5ff0125a03c8d47 Depends-On: Ie0c9f24df09255e871f904e079b68809144b36b4
* Remove unneeded requirements fileJens Harbott2017-12-071-2/+0
| | | | | | | Need to make requirements-check non-voting in order for this to pass, will undo that afterwards. Change-Id: I939ef1da660e939fe0ff9c6eaa4919e3e1d21fee
* Update and optimize documentation linksHangdong Zhang2017-07-194-4/+4
| | | | | | | | 1. Update URLs according to document migration 2. Update the dead and outdated links 3. Optimize (e.g. http -> https) Change-Id: I426747fbeb2277a5cddacf589234c0fdcfc5d673
* switch from oslosphinx to openstackdocsthemeDoug Hellmann2017-07-101-1/+8
| | | | | Change-Id: Idd2542a0be57e9ed52718654649f945b85c4ed0a Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* import cli-reference material from openstack-manualsDoug Hellmann2017-07-102-0/+959
| | | | | Change-Id: Ida7c2fb3f987aa2cef5f2eaba52f36413547de71 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* rearrange the existing docs into the new standard layoutDoug Hellmann2017-07-1011-17/+40
| | | | | Change-Id: I1cf25aade215aad3ce9050af7c9fa8987564863c Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Update cli docsGraham Hayes2017-07-102-68/+37
| | | | | | | | Marked V1 API docs as deprecated Moved to "example.(org|net|com). domains Removed servers cli examples (as they are now dangerous with v2 API) Change-Id: I3e1fa170dc189cc5dac608a9aecacd9127a2233e
* doc: Remove cruft from conf.pyStephen Finucane2017-04-201-193/+1
| | | | Change-Id: I2cdb0c7ed4b7ef9deb12454fe2fe7361edc9438c
* Use Sphinx 1.5 warning-is-errorStephen Finucane2017-04-201-0/+1
| | | | | | | | | | | With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as errors is setting warning-is-error in build_sphinx section. Migrate the setting from the old warnerrors one. This involves a couple of changes to the docs to fix the now broken build. Change-Id: I9bee7f6f9c69a9ed7bb22325ad1a0a1316dde526
* Simplify OSC doc structureTim Simmons2017-02-233-423/+431
| | | | | | | | | This page should be linked from the main docs as a place to see the various commands that are possible. This moves the more verbose examples to one place and delete the other page. There was also some grammar that bugged me so I changed it Change-Id: I8bc23e493794a43d7f6eb4d5bd5dce965c8ff11d
* Fix broken link for modindexsonu.kumar2017-01-261-1/+1
| | | | | | | The documentation build does not generate any module index, therefore modified setup.cfg to create module index. Change-Id: I6140896d5779e8360c866267601713bbf572fee4
* Fix for bug 1627945ashish-kumar-gupta2016-10-131-1/+1
| | | | | | | Documentation doesn't specify that admin credentials are needed to zone abandon Change-Id: I3f3d2ae35824bcffa285878629fd4a841c0cf602 Closes-Bug: #1627945
* Docs update for FloatingIP's ptr recordssonu.kumar2016-08-081-6/+17
| | | | Change-Id: If6e7dd77d43bc541a7e872b7fc6964874e3f3463
* Merge "Allow cli to query "v2/recordsets""Jenkins2016-06-291-0/+1
|\
| * Allow cli to query "v2/recordsets"Graham Hayes2016-06-091-0/+1
| | | | | | | | | | | | | | | | The allows users to list all recordsets in the system. running ``openstack recordset list all`` will show all rrsets Change-Id: Id47961c80484550c99c1834a554afe31165b69ca
* | Add `openstack zone transfer accept list` cli to designateclientsonu.kumar2016-06-142-0/+7
|/ | | | | | | | | | | This patch add cli for listing accepted zone ownership transfer and corresponding test cases. Related-Bug: #1499539 Change-Id: I3eec36c73b2dacd4eed3b8578c4d51593b43104d depends-on: I3dc042f666be43649bb3dec6e92cc67d1c32578f
* Use the correct capitalization of OpenStackDougal Matthews2016-05-182-4/+4
| | | | Change-Id: If02429ed7254e4cd543b2f22f7685bf045fb4cd6
* Merge "Update doc examples to use keystoneauth"Jenkins2016-05-117-42/+85
|\
| * Update doc examples to use keystoneauthClenimar Filemon2016-05-067-42/+85
| | | | | | | | | | | | | | | | | | | | | | As keystoneclient's Session and auth plugins have been deprecated in favor of keystoneauth, the documentation examples must reflect that. This patch updates all examples in order to show keystoneauth Session usage instead of deprecated keystoneclient Session. Also, the python API bindings were updated too. Change-Id: I4b64fee4f526cc5b4a5e36cc8edb61164ceded51
* | Docs Updatesonu.kumar2016-05-101-0/+166
|/ | | | | | This patch updates docs for v2 cli examples. Change-Id: I2e8c7e8259ce8b3e446e33862e1c8a57b0cf3690
* Update designate cli page with more examplesReddy A, Penchal (pr8721)2016-05-061-1/+112
| | | | | | Closes-Bug: #1578207 Change-Id: I775e12510b0705e8ab797bf34e9b38d4853e65c1
* Improve python-designateclient docsRahman Syed2016-04-207-45/+393
| | | | | | | | | | | | | * Improve index page to explain the difference between v1 and v2 CLI support. * Add a v2 examples page * Add all supported commands to v2 shell page * Add a tox task to build the docs * Fix a bug building the docs with an invalid html_static_path config Change-Id: Ie1e65c2d0cc8ad1b8b258e03114e19a943d1d19c Closes-Bug: 1572217
* Doc changes for installation webpageVenkata Mahesh Jonnalagadda2016-03-301-1/+1
| | | | | Change-Id: I8dba20b06680262ecd67df7165bd5ec0baed97a2 Closes-Bug: #1563865
* Fixed grammar mistake in shell.rstAndrew F. Ly2016-01-201-1/+1
| | | | | | | This trivial commit fixes a grammar mistake in the documentation. Change-Id: I0e2a8bf75bf1f5a1bc1f64cc59e0c4ab4e67dbaf Closes-Bug: 1536369
* Merge "Fixes doc for v2 cli"Jenkins2015-11-041-2/+2
|\
| * Fixes doc for v2 clisonu.kumar2015-10-301-2/+2
| | | | | | | | | | Change-Id: I7994d3d0ea8ff1fd0f6471f05a1c35d1f4920d9d Closes-Bug: #1511225
* | Updates shell doc of v1 clientsonu.kumar2015-11-042-87/+160
|/ | | | | | | | This patch updates shell doc of designate v1 client. Closes-Bug: #1511672 Change-Id: Iaa35b4fa97e0a3680769c0942a51c28e7cede2fc
* Merge "Layout some functional tests for the V2 CLI"Jenkins2015-09-242-0/+68
|\
| * Layout some functional tests for the V2 CLIPaul Glass2015-09-232-0/+68
| | | | | | | | Change-Id: Ib2d1261bcb0362c586c0aae4b9c5a8a563f07c71
* | Merge "Implement socket timeout in v1"Jenkins2015-09-081-1/+1
|\ \ | |/ |/|
| * Implement socket timeout in v1Federico Ceratto2015-08-111-1/+1
| | | | | | | | | | | | | | | | | | Add endpoint_override keyword to v2.Client() and check for the session argument in DesignateAdapter() Add unit test, fix minor typos Change-Id: I038ec7b0d1feadc9642bd47285e397b3fe84c13c Closes-Bug: 1469739
* | Merge "V2 CLI Support"Jenkins2015-09-023-0/+72
|\ \
View Lorry Controller Status