openstack/python-openstackclient
Code Issues Proposed changes
c7e3529dea
python-openstackclient/doc/requirements.txt

31 lines
1.0 KiB
Plaintext
Raw Normal View History

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-18 22:28:48 +02:00
openstackdocstheme>=2.2.1 # Apache-2.0
reno>=3.1.0 # Apache-2.0
sphinx>=2.0.0,!=2.1.0 # BSD
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-04-03 17:29:59 +01:00
sphinxcontrib-apidoc>=0.2.0 # BSD
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:09:10 -05:00
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-04 17:42:57 -06:00
# redirect tests in docs
whereto>=0.4.0 # Apache-2.0
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:09:10 -05:00
# Install these to generate sphinx autodocs
aodhclient>=0.9.0 # Apache-2.0
gnocchiclient>=3.3.1 # Apache-2.0
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 15:45:36 -05:00
osc-placement>=1.7.0 # Apache-2.0
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:09:10 -05:00
python-barbicanclient>=4.5.2 # Apache-2.0
Add plugin doc page for cyborg This patch add cyborg (accelerator) doc page. Change-Id: I0f3e5419ce522e620be805c0fcd829c8dfb2e317
2020-09-15 17:15:46 +09:00
python-cyborgclient>=1.2.1 # Apache-2.0
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:09:10 -05:00
python-designateclient>=2.7.0 # Apache-2.0
python-heatclient>=1.10.0 # Apache-2.0
python-ironicclient>=2.3.0 # Apache-2.0
python-ironic-inspector-client>=1.5.0 # Apache-2.0
Add OpenStack Client for Manila docs This commit includes documentation about OSC implementation for Manila. bp openstack-client-support Change-Id: Ic91a81e16e506103c08ef42ed0f8634a2b70e1dd
2020-02-06 10:36:41 +00:00
python-manilaclient>=2.0.0 # Apache-2.0
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:09:10 -05:00
python-mistralclient!=3.2.0,>=3.1.0 # Apache-2.0
python-muranoclient>=0.8.2 # Apache-2.0
python-neutronclient>=6.7.0 # Apache-2.0
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-22 14:18:51 -05:00
python-octaviaclient>=1.11.0 # Apache-2.0
python-rsdclient>=1.0.1 # Apache-2.0
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:09:10 -05:00
python-saharaclient>=1.4.0 # Apache-2.0
python-senlinclient>=1.1.0 # Apache-2.0
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-22 14:18:51 -05:00
python-troveclient>=3.1.0 # Apache-2.0
python-watcherclient>=2.5.0 # Apache-2.0
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:09:10 -05:00
python-zaqarclient>=1.0.0 # Apache-2.0
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-22 14:18:51 -05:00
python-zunclient>=3.6.0 # Apache-2.0
Copy Permalink