summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* [ussuri][goal] Update contributor documentationGhanshyam Mann2021-06-012-9/+55
| | | | | | | | | | | This patch updates/adds the contributor documentation to follow the guidelines of the Ussuri cycle community goal[1]. [1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html Story: #2007236 Task: #38524 Change-Id: If5d20838a653687a142134a9645254d9c51dba78
* Switch to newer openstackdocstheme and reno versionsAndreas Jaeger2020-05-222-22/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. 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. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I5598eebe898555869cd65a74950fdbd76a7baa46
* Update hacking for Python3ussuri-em2.1.0Andreas Jaeger2020-03-311-0/+1
| | | | | | | | | The repo is Python 3 now, so update hacking to version 3.0 which supports Python 3. Fix problems found. Change-Id: I82c745f5b1236844deec4538be84037a64eebeee
* [ussuri][goal] Drop python 2.7 support and testing2.0.0Andreas Jaeger2020-02-101-2/+1
| | | | | | | | | | | | | OpenStack is dropping the py2.7 support in ussuri cycle. Complete discussion & schedule can be found in - http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html - https://etherpad.openstack.org/p/drop-python2-support Ussuri Communtiy-wide goal: https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html Change-Id: I54863f2301758dcd48de4ee73bcc8582e5036afa
* Merge "Replace git.openstack.org URLs with opendev.org URLs"Zuul2019-12-051-1/+1
|\
| * Replace git.openstack.org URLs with opendev.org URLsjacky062019-07-141-1/+1
| | | | | | | | Change-Id: I65ec66ebcef80609a4fc111c71a225eccec35eeb
* | Cap sphinx for py2 to match global requirementszhangboye2019-06-061-1/+2
|/ | | | Change-Id: Icbc1b3a92f796bf9e3186a512dd21661db035583
* Migrate the link of bug report button to storyboardzhulingjie2018-08-301-2/+2
| | | | Change-Id: I28dc73a0b21719c02ea3b7fa47c68326bb87832d
* Update the documentation link for doc migrationlingyongxu2018-06-091-1/+1
| | | | | | | | | This patch is proposed according to the Direction 10 of doc migration. https://etherpad.openstack.org/p/doc-migration-tracking Co-Authored-By: Nguyen Hai <nguyentrihai93@gmail.com> Change-Id: I9675af92149ab126534f541534b50a02688e5337
* Merge "Improve titles of generated API documentation"Zuul2018-06-041-6/+10
|\
| * Improve titles of generated API documentationZane Bitter2018-04-061-6/+10
| | | | | | | | Change-Id: I1a5820e979418063b7e203acc5e07ce0e7be30bd
* | Fix osc cli docsrabi2018-06-041-2/+2
|/ | | | | | | | In d1d4387babd7b249fc1fc3871a5756f88263c7e1 we changed to auto generate osc cli docs. But it seems some of them use incorrect commands. Change-Id: I650b09a1d998269cce767a59aaf92e0cc5797bc7
* Follow the new PTI for document buildricolin2018-03-231-0/+4
| | | | | | | | | | | For compliance with the Project Testing Interface as described in: https://governance.openstack.org/tc/reference/project-testing-interface.html Refer to: http://lists.openstack.org/pipermail/openstack-dev/2017-November/124815.html Change-Id: Ibb35b13fe121fa2489ef31f51e1a662fbd01cc8b Co-Authored-By: Nguyen Hai <nguyentrihai93@gmail.com>
* Document osc CLIZane Bitter2018-01-257-11/+228
| | | | | Change-Id: Idafe730021f272360ac0588f8b35e7d392c96d4b Closes-Bug: #1735019
* Remove vestigate HUDSON_PUBLISH_DOCS referenceMonty Taylor2017-09-021-4/+1
| | | | | | | This isn't actually used and is a leftover from a thing we did seven years ago that survives today through copy-pasta. Change-Id: Ic77d867ee1afaf4586a9fcbab5c36166e38604b6
* Switch from oslosphinx to openstackdocsthemeVan Hung Pham2017-07-031-14/+8
| | | | | | | | | As part of the docs migration work[0] for Pike we need to switch to use the openstackdocstheme. [0]https://review.openstack.org/#/c/472275/ Change-Id: I730996eb74d16ede3725494b561dc15493741c75
* Fix doc on keystoneauth session api usagerabi2016-12-081-7/+12
| | | | | | | | This fixes documentation on client creation with keystoneauth session api. Change-Id: I0f6bb6f4f9bbaa84b5185c0a9e9db6a4184702d4 Partial-Bug: #1646539
* Fix doc build if git is absentThomas Bechtold2016-07-131-2/+8
| | | | | | | | | 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: If6585c62ed783f38b2b80afa7fc9795f7e9426a6 Closes-Bug: #1552251
* Add an example on keystoneauth Sessions to the docClenimar Filemon2016-03-071-0/+18
| | | | | | | | | | keystoneauth Session object brings an unified interface of authentication to a variety of OpenStack services. Some components (e.g. Nova, Glance) already have an example on their Python API docs. This patch adds an example on how to create a heat Client instance using keystoneauth Session API. Change-Id: Iaa51052ccb4c66aafa11e9bfd6befbd831715110
* Replace deprecated library function os.popen() with subprocessLiuNanke2016-01-091-2/+5
| | | | | | | | os.popen() is deprecated since version 2.6. Resolved with use of subprocess module. Closes-bug: #1529836 Change-Id: I04978ecdce04c8817c4c1c231ba7e65b908f5471
* Enable pep8 E265 testricolin2015-11-231-40/+40
| | | | | | Enable E265 block comment should start with '# ' Change-Id: I78813e73f8dd800bc58a1d69eedc2c066ccb8c28
* OpenStack typodixiaoli2015-11-181-1/+1
| | | | | | | | change capitalization of OpenStack in file doc/source/man heat.rst TrivialFix Change-Id: I9f40fa7b2ed953ae6f2bb305f3028ec63b7262df
* Updates heat.rst with 'service-listKanagaraj Manickam2015-02-121-0/+4
| | | | | | | Updates heat.rst man page with new command 'heat service-list' Change-Id: I9f3d6ca5e4c489a65344fb451be4c274e8298129 Closes-bug: #1421299
* Add adopt/abandon description to heat manualkairat_kushaev2015-02-041-0/+7
| | | | | | | Added adopt command description to heat manual. Added note that adopt/abandon are disabled by default. Change-Id: I36d0b70fe32750b82cd5fe9cf0403866b8501ed9
* 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: Idba76cc145aaf7636b68ece14598ef67b811275c
* Stop using intersphinxAndreas Jaeger2014-09-131-1/+1
| | | | | | | | | | | | | | Remove intersphinx from the docs build as it triggers network calls that occasionally fail, and we don't really use intersphinx (links other sphinx documents out on the internet) This also removes the requirement for internet access during docs build. This can cause docs jobs to fail if the project errors out on warnings. Change-Id: I71e941e2a639641a662a163c682eb86d51de42fb Related-Bug: #1368910
* Update theme for docsSteve Martinelli2014-07-241-1/+1
| | | | | | | | 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: I97817b8c6d8bef71c4f237be864d1e79dc09098c
* add output-list and output-showLars Kellogg-Stedman2014-02-201-0/+8
| | | | | | | | | | | | | | | | This patch adds the "output-list" and "output-show" commands to heat. The first prints a table of available outputs to stdout, and the second prints a single output_value to stdout. All outputs are serialized to JSON. This patch includes tests for the new commands as well as updated documentation. Implements blueprint: stack-outputs-in-shell Change-Id: Iaade16d043b2c42d14f642fde17419eaa07d0ab8 Closes-Bug: 1258622
* Add support for software config resourcesSteve Baker2014-02-171-1/+2
| | | | | | | | SoftwareConfig lacks update methods as it is immutable. Implements: blueprint hot-software-config-rest Change-Id: I1d05433303c182f03d21378fd66af4f589b7821b
* python-heatclient stack-abandon supportVijendar Komalla2014-02-101-0/+3
| | | | | | | Adding stack-abandon support for python-heatclient. Partial-Bug: #1262267 Change-Id: Ifaec08558103137fe8288d00ba8d7188f01afe03
* Fix some trivial py3 errorsChmouel Boudjnah2014-01-111-1/+1
| | | | Change-Id: I72334d2ca82057e591dca4fcfa9ef7ecdd3b6878
* Added API reference documentJUN JIE NAN2014-01-064-0/+80
| | | | | | | The API reference document is missing so addded it and enabled pep8 check for conf.py. Change-Id: I04236c5427d7ac624781fbfc920a79f855d8cd75
* Wrapped some long linesJUN JIE NAN2014-01-021-6/+17
| | | | | | Some lines has been wrapped some not. So wrapped the left long lines. Change-Id: I67b40e580b53cb7dca40112b3a3c112c359893dd
* Fixed typo error OS_IMAGE_URLJUN JIE NAN2014-01-021-5/+13
| | | | | | | OS_IMAGE_URL is not coorect, replaced it with HEAT_URL and did according changes. Change-Id: I0c06dfe6c013a358a46eab2ce4e9b7a44d98672d
* Add a basic man page for heatAngus Salkeld2013-11-123-0/+89
| | | | | | | This shows a taste of commands and shows how to access the help Closes-bug: #1153824 Change-Id: Ia69072c224e8940927dce0c984040d4c81bcee45
* Add a top level introduction to the indexAngus Salkeld2013-10-291-2/+7
| | | | Change-Id: Icfe152a2829c2cb82a0955b91052183d7c488510
* Add a contibuting section to index.rstAngus Salkeld2013-10-291-0/+10
| | | | | | | This should make it look more consistent with the other projects. Change-Id: I2a3dd716215e68e2bafed17d059010ccb70d6ccf
* Remove the release notes as it is not maintained hereAngus Salkeld2013-10-291-8/+0
| | | | Change-Id: I7e558c23df59cba3668e3f3bcf6ca2413b72e178
* Resync doc/source/conf.py from heat for consistencyAngus Salkeld2013-10-291-26/+210
| | | | | Change-Id: I77c5abbd22517ed99475b891d380583e06a04cf6 Partial-bug: #1153824
* Add doc/Makefile to help with building docsAngus Salkeld2013-10-292-0/+91
| | | | | Change-Id: I8894705891a02c06919e1b1c816ceb5137609b81 Partial-bug: #1153824
* Replace OpenStack LLC with OpenStack FoundationZhiQiang Fan2013-09-201-2/+2
| | | | | Change-Id: I8f2697ca99192078d5db2adb4db98287520d9895 Fixes-Bug: #1214176
* Initial importSteve Baker2012-10-102-0/+97
View Lorry Controller Status