Commit Graph

43 Commits

Author SHA1 Message Date
niuke 9bfa8e469a remove unicode prefix from code (1)
In Python 3, unicode prefix is meaningless. This removes unicode prefix
from code files used to generate documentations

Change-Id: I7bcf9dd502b218238be9ee94c31590d4112edcf4
2022-08-07 01:09:55 +09:00
Ghanshyam Mann cc2014fec1 [ussuri][goal] Update contributor documentation
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
2021-06-01 02:04:18 +00:00
Andreas Jaeger 3fa304428c Switch to newer openstackdocstheme and reno versions
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
2020-05-22 17:20:37 +00:00
Andreas Jaeger 9dede4eb2b Update hacking for Python3
The repo is Python 3 now, so update hacking to version 3.0 which
supports Python 3.

Fix problems found.

Change-Id: I82c745f5b1236844deec4538be84037a64eebeee
2020-03-31 10:04:12 +00:00
Andreas Jaeger 2a8eb6a74c [ussuri][goal] Drop python 2.7 support and testing
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
2020-02-10 16:05:51 +00:00
Zuul 1120822e0c Merge "Replace git.openstack.org URLs with opendev.org URLs" 2019-12-05 03:50:40 +00:00
jacky06 87253c46fd Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I65ec66ebcef80609a4fc111c71a225eccec35eeb
2019-07-14 15:05:49 +00:00
zhangboye 0789bc93dc Cap sphinx for py2 to match global requirements
Change-Id: Icbc1b3a92f796bf9e3186a512dd21661db035583
2019-06-06 16:04:52 +08:00
zhulingjie dc07c1358a Migrate the link of bug report button to storyboard
Change-Id: I28dc73a0b21719c02ea3b7fa47c68326bb87832d
2018-08-30 07:01:05 -04:00
lingyongxu 1cc69c0272 Update the documentation link for doc migration
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
2018-06-09 01:38:24 +00:00
Zuul 83d102537e Merge "Improve titles of generated API documentation" 2018-06-04 09:48:42 +00:00
rabi 36df27d61b Fix osc cli docs
In d1d4387bab we changed to auto
generate osc cli docs. But it seems some of them use incorrect
commands.

Change-Id: I650b09a1d998269cce767a59aaf92e0cc5797bc7
2018-06-04 12:50:26 +05:30
Zane Bitter bf2b57a92b Improve titles of generated API documentation
Change-Id: I1a5820e979418063b7e203acc5e07ce0e7be30bd
2018-04-06 15:10:28 -04:00
ricolin f41ad78cd4 Follow the new PTI for document build
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>
2018-03-23 10:45:18 -04:00
Zane Bitter d1d4387bab Document osc CLI
Change-Id: Idafe730021f272360ac0588f8b35e7d392c96d4b
Closes-Bug: #1735019
2018-01-25 10:02:04 -05:00
Monty Taylor 551e6bec3d
Remove vestigate HUDSON_PUBLISH_DOCS reference
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
2017-09-02 09:00:08 -05:00
Van Hung Pham 2663e8d75c Switch from oslosphinx to openstackdocstheme
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
2017-07-03 08:13:04 +07:00
rabi 3d60183120 Fix doc on keystoneauth session api usage
This fixes documentation on client creation with keystoneauth
session api.

Change-Id: I0f6bb6f4f9bbaa84b5185c0a9e9db6a4184702d4
Partial-Bug: #1646539
2016-12-08 13:03:20 +05:30
Thomas Bechtold 4386261278 Fix doc build if git is absent
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
2016-07-13 17:09:16 +02:00
Clenimar Filemon bd9008ed5b Add an example on keystoneauth Sessions to the doc
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
2016-03-07 01:10:30 -03:00
LiuNanke 5e92ba8f44 Replace deprecated library function os.popen() with subprocess
os.popen() is deprecated since version 2.6. Resolved with use of
subprocess module.
Closes-bug: #1529836

Change-Id: I04978ecdce04c8817c4c1c231ba7e65b908f5471
2016-01-09 22:17:16 +08:00
ricolin 6f1542c2ca Enable pep8 E265 test
Enable E265 block comment should start with '# '

Change-Id: I78813e73f8dd800bc58a1d69eedc2c066ccb8c28
2015-11-23 23:45:04 +08:00
dixiaoli a83a392585 OpenStack typo
change capitalization of OpenStack in file doc/source/man heat.rst

TrivialFix

Change-Id: I9f40fa7b2ed953ae6f2bb305f3028ec63b7262df
2015-11-18 09:11:04 +00:00
Kanagaraj Manickam d565efc555 Updates heat.rst with 'service-list
Updates heat.rst man page with new command 'heat service-list'

Change-Id: I9f3d6ca5e4c489a65344fb451be4c274e8298129
Closes-bug: #1421299
2015-02-12 22:28:34 +05:30
kairat_kushaev edf3014e48 Add adopt/abandon description to heat manual
Added adopt command description to heat manual.
Added note that adopt/abandon are disabled by default.

Change-Id: I36d0b70fe32750b82cd5fe9cf0403866b8501ed9
2015-02-04 09:34:18 +00:00
Jeremy Stanley 39c1846b1f Workflow documentation is now in infra-manual
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.

Change-Id: Idba76cc145aaf7636b68ece14598ef67b811275c
2014-12-05 03:30:39 +00:00
Andreas Jaeger 16ac43a404 Stop using intersphinx
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
2014-09-13 09:41:51 +02:00
Steve Martinelli 884ad37d8a Update theme for docs
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
2014-07-24 21:24:28 -04:00
Lars Kellogg-Stedman 60f3de47e3 add output-list and output-show
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
2014-02-20 10:40:56 -05:00
Steve Baker b58202caa7 Add support for software config resources
SoftwareConfig lacks update methods as it is immutable.

Implements: blueprint hot-software-config-rest

Change-Id: I1d05433303c182f03d21378fd66af4f589b7821b
2014-02-17 10:31:33 +08:00
Vijendar Komalla a94108ab26 python-heatclient stack-abandon support
Adding stack-abandon support for python-heatclient.

Partial-Bug: #1262267
Change-Id: Ifaec08558103137fe8288d00ba8d7188f01afe03
2014-02-10 10:17:36 +13:00
Chmouel Boudjnah b293243185 Fix some trivial py3 errors
Change-Id: I72334d2ca82057e591dca4fcfa9ef7ecdd3b6878
2014-01-11 08:02:25 +01:00
JUN JIE NAN 276b1e4ed5 Added API reference document
The API reference document is missing so addded it and enabled pep8
check for conf.py.

Change-Id: I04236c5427d7ac624781fbfc920a79f855d8cd75
2014-01-06 13:25:00 +08:00
JUN JIE NAN e2d7ebff7e Wrapped some long lines
Some lines has been wrapped some not. So wrapped the left long lines.

Change-Id: I67b40e580b53cb7dca40112b3a3c112c359893dd
2014-01-02 13:22:52 +08:00
JUN JIE NAN 39ca592c55 Fixed typo error OS_IMAGE_URL
OS_IMAGE_URL is not coorect, replaced it with HEAT_URL and did
according changes.

Change-Id: I0c06dfe6c013a358a46eab2ce4e9b7a44d98672d
2014-01-02 13:21:13 +08:00
Angus Salkeld 56f97606d8 Add a basic man page for heat
This shows a taste of commands and shows how to access the help

Closes-bug: #1153824
Change-Id: Ia69072c224e8940927dce0c984040d4c81bcee45
2013-11-12 16:15:40 +11:00
Angus Salkeld ed81b3ad24 Add a top level introduction to the index
Change-Id: Icfe152a2829c2cb82a0955b91052183d7c488510
2013-10-29 21:59:46 +11:00
Angus Salkeld 3204ead19f Add a contibuting section to index.rst
This should make it look more consistent with the other
projects.

Change-Id: I2a3dd716215e68e2bafed17d059010ccb70d6ccf
2013-10-29 21:59:46 +11:00
Angus Salkeld ed6c24e064 Remove the release notes as it is not maintained here
Change-Id: I7e558c23df59cba3668e3f3bcf6ca2413b72e178
2013-10-29 21:59:46 +11:00
Angus Salkeld da932c19c7 Resync doc/source/conf.py from heat for consistency
Change-Id: I77c5abbd22517ed99475b891d380583e06a04cf6
Partial-bug: #1153824
2013-10-29 21:59:24 +11:00
Angus Salkeld 6a5e8b7e86 Add doc/Makefile to help with building docs
Change-Id: I8894705891a02c06919e1b1c816ceb5137609b81
Partial-bug: #1153824
2013-10-29 20:29:30 +11:00
ZhiQiang Fan 455b1cb4e8 Replace OpenStack LLC with OpenStack Foundation
Change-Id: I8f2697ca99192078d5db2adb4db98287520d9895
Fixes-Bug: #1214176
2013-09-20 04:21:21 +08:00
Steve Baker 1269bb20c7 Initial import 2012-10-10 08:55:03 +13:00