Commit Graph

26 Commits

Author SHA1 Message Date
Zuul 6e246f1566 Merge "doc: Remove RSD subcommand" 2024-01-30 09:31:43 +00:00
Takashi Kajinami 49ad528266 doc: magnumclient provides a OSC plugin
The magnumclient library now provides an OSC plugin. So update
the document accordingly.

Change-Id: Ie828f005a38a511bb0f34ab86cbf97e4a3aae2fe
2024-01-29 23:20:07 +00:00
Takashi Kajinami 82c3474323 doc: Remove RSD subcommand
The python-rsdclient library hasn't been updated for 5 years and is no
longer maintained.

Change-Id: Ia378a9001836bbaa4f679dddf1ed743e4332a72e
2024-01-21 22:12:08 +09:00
Shogo Saito 7f89b109cf Add plugin doc page for cyborg
This patch add cyborg (accelerator) doc page.

Change-Id: I0f3e5419ce522e620be805c0fcd829c8dfb2e317
2022-12-20 12:33:00 +00:00
Stephen Finucane 8b0e467355 Remove invalid note from requirements files
This isn't true with the new dependency resolver introduced in pip 20.3.

Change-Id: Ie28fe625663c960fbffa12efb1503b8c9f8c0581
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2022-08-24 11:03:52 +01:00
Stephen Finucane d33eb3e1da Remove retired Karbor support
The Karbor project is being retired in Wallaby [1]. Remove the docs for
its client.

[1] http://lists.openstack.org/pipermail/openstack-discuss/2020-November/018643.html

Change-Id: I52d0f6a76cc9bcfc8b33f0e2cd3751859770ac8a
Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
2021-01-08 18:43:05 +00:00
Ghanshyam Mann a79e7db4ae Remove retired Searchlight support
Searchlight project is retiring in Wallaby cycle[1].
This commit removes the support/usage of Searchlight project
before its code is removed.

Needed-By: https://review.opendev.org/c/openstack/searchlight/+/764526

[1] http://lists.openstack.org/pipermail/openstack-discuss/2020-November/018637.html

Change-Id: Idad97343b9ce66186d50ee0560a2fded66655f9b
2020-12-08 19:48:54 +00:00
Zuul 730a8505f6 Merge "Add OpenStack Client for Manila docs" 2020-06-08 23:17:53 +00:00
Maari Tamm aa7b84fd08 Add OpenStack Client for Manila docs
This commit includes documentation about OSC
implementation for Manila.

bp openstack-client-support

Change-Id: Ic91a81e16e506103c08ef42ed0f8634a2b70e1dd
2020-06-06 15:48:10 +00:00
Zuul 57c02953ac Merge "Switch to newer openstackdocstheme and reno versions" 2020-06-05 18:32:11 +00:00
Andreas Jaeger b5389dab02 Remove congress
Congress and python-congressclient have been retired and also
removed from global requirements, thus requirements-check job fails.

Remove congress from this repo.

Change-Id: Ibf68fee49e69264a1c46b2f456901d2620befe3c
2020-06-04 18:29:49 +02:00
Andreas Jaeger 709dfd9c21 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.

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: Id3989cabdbf2204821531b00149aa0f1cb8a4955
2020-05-20 21:54:12 +02:00
Monty Taylor e6e4b73efa Complete "Drop python2 support" goal
We stopped testing python2, but there are more things to be cleanup.

- Remove python2 entries from setup.cfg
- Add releasenotes
- remove universal wheel since this is only python 3 now

Change-Id: Ie2bbb4d34b8411939ad5cfd750fc76c933779542
2020-02-05 05:58:51 +00:00
Eric Fried 6f07828bf0 Add redirect testing
Adds a dependency on and invocation of the `whereto` command to validate
redirects in the .htaccess file during doc builds.

Change-Id: Ib6cc2953f0fd774de3c3a0c8a2bd6cff49667c14
2019-11-05 07:09:05 -06:00
Eric Fried 977b0c8591 Use autoprogram-cliff for remaining plugin docs
Sphinx errors have been fixed in the plugin projects for octavia, rsd,
trove, watcher, and zun, so we can now use autoprogram-cliff to generate
the docs for those.

Change-Id: Ia7790c5e86957afd0aec8f9a04ffc7aa968b4eeb
Story: #1735016
Task: #37241
2019-10-28 14:05:37 -05:00
Eric Fried 67a5654d49 Add plugin doc page for watcher
This was being omitted because whenever the plugin page was produced,
python-watcherclient wasn't in global-requirements. It is now, so
include a page for it in the plugin docs.

NOTE: We would like to use autoprogram-cliff to make the documentation
complete, but that breaks the build. For now, this is better than
nothing.

Change-Id: I49822242b9a0c031a053d6c2fd9f644a585f4ba5
2019-10-21 18:08:41 -05:00
Eric Fried 8cdc7348d1 Add placement to known plugins
Add the osc-placement project (osc plugin for the placement service) to
the list of known plugins.

Change-Id: I77b614b38ecf872d0d93473b834994913930b76f
2019-10-21 16:11:09 -05:00
Eric Fried cf1006bf0e Fix plugin autodoc generation
Documentation for plugins wasn't being generated because the plugin
projects weren't being installed in the docs environment. Add them to
doc/requirements.txt to make this work.

Change-Id: Id9be39971110fd2eb4519a0582c9bf2514cdcacd
Story: #1735016
Task: #13825
2019-10-21 16:10:56 -05:00
Natal Ngétal f179117976 Update sphinx requirement.
Sphinx 2.0 no longer works on python 2.7, start cappingit there as well.

Change-Id: I8a7d227b2f925066fc8213aa62b5756927ee263b
2019-05-15 14:13:49 +02:00
Matt Riedemann 8ce203f879 Fix docs bug link to go to storyboard rather than launchpad
This fixes the docs bug link generation for the normal docs
and release notes docs.

The requirement on openstackdocstheme is bumped to 1.23.2 to
pick up fix I2ed164b9b0badade702c50543ac1a5eea4d1867b.

Change-Id: I89711a391ee0fb7e40c1fbf83f950e2b582358d9
Story: #2005467
Task: #30546
2019-04-16 18:40:14 -04:00
Stephen Finucane 63d741fd66 Replace pbr autodoc with sphinxcontrib-apidoc
This fixes local building of the documentation using tox, and allows the
gate to stop relying on pbr and move completely to the new docs PTI.

http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Change-Id: I485acda07098a435753e91c1ca45e586de199c35
2018-07-10 17:15:26 +01:00
OpenStack Proposal Bot 26b1732a7c Updated from global requirements
Change-Id: I8c400b12269f00fcf9fcaac27098ca55cdc27ac4
2018-03-28 10:36:59 +00:00
OpenStack Proposal Bot fbee4eb762 Updated from global requirements
Change-Id: I7b712b41e633f7e3dc40749b5a55706cb32fecee
2018-01-24 01:31:48 +00:00
OpenStack Proposal Bot 001efadbde Updated from global requirements
Change-Id: Ic5715c21e19d92c8f3d85091bfa41c28bb271c42
2018-01-18 03:30:37 +00:00
OpenStack Proposal Bot cc47c075a0 Updated from global requirements
Change-Id: Ic85eb65f3f143fdfbf2b6fa71d7cdd6961b24c76
2018-01-09 16:21:50 +00:00
Guoqiang Ding 42e0037cd0 Update new documentation PTI jobs
For compliance with the Project Testing Interface as described in [1].
For more detailed information, please refer to [2].

[1] https://governance.openstack.org/tc/reference/project-testing-interface.html
[2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I7e8c47dead1e019e8705db3ff7559dd39b1d90d9
2017-12-28 16:16:28 +00:00