Commit Graph

28 Commits

Author SHA1 Message Date
wu.chunyang 3b56a5e0f7 kolla-cli: deprecation - Removing project content
step 2b from:
https://docs.openstack.org/project-team-guide/repository.html#step-2b-remove-project-content

Deprecation notice:
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014983.html

Change-Id: I744f5c17232928cec68c1b90b2f5d791faf7d9e7
Depends-On: https://review.opendev.org/748259
2020-09-03 09:58:43 +02:00
Christian Berendt 7ba715987a README: add deprecation note
Change-Id: I83d919e5aa8de2765a5405d0d2fafbe0a012b05e
2020-05-26 07:46:36 +00:00
gugug a0e3dde568 Fix pygments style
New theme of docs (Victoria+) respects pygments_style.
Since we starts using Victoria reqs while being on Ussuri,
this patch ensures proper rendering both in Ussuri and Victoria.

Change-Id: Ibd9a69ce0a546e8f58393fa767a044e931809ace
2020-05-20 08:07:06 +08:00
Ghanshyam Mann 3f9b0679ab [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

kolla-cli also drop py2 testing and support.

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: I44fe93012739ad190f8d0fe593e70863ab238158
2020-03-01 10:46:00 +00:00
huangliujie ecff34a332 Blacklist sphinx 2.1.0 (autodoc bug)
See https://github.com/sphinx-doc/sphinx/issues/6440 for upstream details

Change-Id: I55bdac059dd474280dc35855a269c67fec58b022
2019-10-17 17:42:10 +08:00
caoyuan 1ec3980879 tox: Keeping going with docs
Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.

[1] sphinx-doc/sphinx@e3483e9

Change-Id: I6c3fcf7519c71058ed1814ac852473b12b17a2e9
2019-10-14 00:52:18 +08:00
jacky06 a7ea023c38 Generate PDF documentation
This patch adds a new tox job/command for building the pdf
version of documentation.

tox -epdf-docs

In addition to adjusting the infra requirement for PDF build
support, the following changes are made to build a PDF doc

- Download link of config_options, sample config and policy
  files are disabled for PDF doc as relative links do not
  make sense.
- Pre-create the doc/build/pdf/_static directory as a
  workaround because sphinx_feature_classification.support_matrix extension
  is operating under the assumption that the _static directory already exist
  and trying to copy support-matrix.css into it. We need to remove
  this workaround once the problem in the support_matrix extension is fixed.
- Use the toctree_only=True workaround to avoid TOC duplicate links.

Change-Id: I8190e0a4f169e1a3268f5e724c30a1c809739dd6
2019-09-10 23:35:24 +08:00
jacky06 55963d94f6 Add reno for release notes management
Change-Id: Ie80cbe5ee84c5dd780938a3464a08e01268cb53f
2019-08-06 15:44:49 +08:00
gujin ba7c612101 Move doc related modules to doc/requirements.txt
Change-Id: Id99f39dd41beaa7d997270a44b355fe184d137b5
2019-08-06 00:29:45 +08:00
jacky06 4a0d70ead9 Use openstackdocstheme and add docs check into zuul
1. Update doc's theme to openstack
2. Add tox docs check into zuul
3. tiny changes, adjust the import order

Change-Id: I0266763f08ffa1445cf985ed0abff0c693e17ef5
2019-08-03 12:45:59 +08:00
jacky06 3babfbaeda Move sphinx-build into tox
Change-Id: I8b98e96a5f8be1d86f388a2fd702eacd3ad07986
2019-08-02 23:43:50 +08:00
zhulingjie a0d28608aa Remove the doc/build
when run `tox -e docs` in localhosts, Sphinx will genatrate doc/build,
it is not necessary for kolla-cli, should be removed from the project

Change-Id: I0a0a15c9dacb20c80f7b71eea3532f39ab9dc36b
2019-07-10 13:42:54 +08:00
Borne Mace 78a1fcedf0 Updating the cli to work against kolla-ansible
Pass one at updating the kolla-cli to work against the official
kolla-ansible bits rather than the internal Oracle ones.  There
are some corresponding changes in the kolla-ansible vagrant
scripts related to bringing up the development environment.

Change-Id: Ia680bb65f904c4dbaf3f05d0334145980c860000
Implements: blueprint functional-single-node
2018-04-17 09:45:35 -07:00
Borne Mace 7da19271e7 Updated version to 4.0.1
Updated version to 4.0.1

Change-Id: Id7ce661b9579c498e940512a4e1ec0ebf414cb3f
2017-12-13 16:20:01 -08:00
Borne Mace 5281bdc67e Updated version from 3.0.1 to 4.0.0
Updated version from 3.0.1 to 4.0.0

Change-Id: Ic8935b441f132b77546a662c4c3b24c3f160714c
2017-03-13 17:09:18 -07:00
Steve Noyes d02b381b48 Update api docs
Change-Id: I98a20e26165ba1ad011e316bf544ffe142333703
Jira-Issue: None
2016-09-26 15:02:49 +02:00
Steve Noyes 17ef5a50a5 add api comment to api about locality of api objects
Jira-Issue: OPENSTACK-932
2016-06-21 11:50:39 -04:00
Steve Noyes aa3b2fe20e update docs
Jira-Issue: None
2016-06-09 15:54:01 -04:00
Steve Noyes 7e6868508a update docs
Jira-Issue: OSTACKDEV-19
2016-04-22 16:56:36 -04:00
Borne Mace d680bb3fdb Updated docs to reflect latest api change for changing multiple properties in a single call.
Jira-Issue: OSTACKDEV-19
2016-04-19 08:59:42 -07:00
Steve Noyes 161d50be72 update docs
Jira-Issue: OSTACKDEV-19
2016-04-14 10:51:56 -04:00
Steve Noyes 41eead32ca Update api docs
Jira-Issue: OSTACKDEV-19
2016-04-06 08:40:38 -04:00
Borne Mace 6f695e5fef Updated api docs
Jira-Issue: OSTACKDEV-19
2016-03-30 16:13:19 -07:00
Steve Noyes fd61b3d730 rebuild & update the docs
Jira-Issue: OSTACKDEV-17
2016-03-24 13:16:47 -04:00
Steve Noyes 8d9e66a281 new password api, partial service api
- new password api - complete
- partial service api: get methods
- created Service api object
- found bug in inventory where parent service
was being cleared out in inventory. Add upgrade code
to fix that.
- added more doc for some classes

Jira-Issue: OSTACKDEV-29
Jira-Issue: OSTACKDEV-18
2016-03-23 14:52:10 -04:00
Borne Mace 1526794b93 Initial API Doc commit
Jira-Issue: OSTACKDEV-25
2016-03-22 13:41:37 -07:00
Borne Mace 5a1596f051 Added initial sphinx documentation support for the python api
Jira-Issue: OSTACKDEV-25
2016-03-21 10:59:42 -07:00
Steve Noyes 2cf49b7bc4 add doc for hosts rest api 2015-11-06 11:07:01 -05:00