delta/openstack/python-openstackclient.git/doc/source/conf.py, branch stein-em opendev.org: openstack/python-openstackclient Replace pbr autodoc with sphinxcontrib-apidoc 2018-07-10T16:15:26+00:00 Stephen Finucane sfinucan@redhat.com 2018-04-03T16:29:59+00:00 63d741fd6646b360818c07a9679344e889031949 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 
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
auto-generate object docs 2017-08-17T20:46:31+00:00 Steve Martinelli s.martinelli@gmail.com 2017-08-17T20:46:31+00:00 4d7b4efeb508f63afbb4b12b9a4506f9fb940d7e Change-Id: I832eade2ddab754664e5f57b9764e524e655e616 
Change-Id: I832eade2ddab754664e5f57b9764e524e655e616
Add .htaccess for docs migration 2017-08-07T23:07:46+00:00 Dean Troyer dtroyer@gmail.com 2017-08-07T23:07:46+00:00 fd7b4f49121d3ac65e3f3a31607ead506d268300 Change-Id: I413a6d059f4eb751ca5c8b5a9b61740ac93680b1 
Change-Id: I413a6d059f4eb751ca5c8b5a9b61740ac93680b1
Start using 'cliff.sphinxext' 2017-07-21T14:48:44+00:00 Stephen Finucane sfinucan@redhat.com 2017-05-30T09:32:19+00:00 9cfa12df2adf9265acb82f9c5aa5f3a26dc56bb1 'cliff', the command line library used by 'osc_lib' (and, thus, 'python-openstackclient') recently gained a Sphinx extension to automatically document cliff commands. This allows us to use the documentation we already have in code instead of duplicating it in the documentation. Introduce the use of this, starting with the 'server' commands. This requires extending the descriptions for two commands to ensure no information is lost. Change-Id: If701af8d5a3f78f4b173ceb476dd0c163be4b6ca 
'cliff', the command line library used by 'osc_lib' (and, thus,
'python-openstackclient') recently gained a Sphinx extension to
automatically document cliff commands. This allows us to use the
documentation we already have in code instead of duplicating it in the
documentation.

Introduce the use of this, starting with the 'server' commands. This
requires extending the descriptions for two commands to ensure no
information is lost.

Change-Id: If701af8d5a3f78f4b173ceb476dd0c163be4b6ca
Fix man page build 2017-07-04T14:54:19+00:00 Javier Pena jpena@redhat.com 2017-07-04T14:53:11+00:00 79b992b53bfea9f3d8e2e073417dbf8f201f37db https://review.openstack.org/473964 moved the man page rst from the doc/source/man directory into doc/source/cli/man, so we need to adjust the path in conf.py to avoid issues when running: python setup.py build_sphinx -b man Change-Id: I1ab09bf298beef756b233c7e17bf052f7af4de51 
https://review.openstack.org/473964 moved the man page rst from
the doc/source/man directory into doc/source/cli/man, so we need to
adjust the path in conf.py to avoid issues when running:

python setup.py build_sphinx -b man

Change-Id: I1ab09bf298beef756b233c7e17bf052f7af4de51
switch to openstackdocstheme 2017-06-26T21:01:19+00:00 Doug Hellmann doug@doughellmann.com 2017-06-26T21:01:19+00:00 cf60df426114ae2ecea504d00c4fa31a153c7353 Change-Id: Iee591504ba5d7506ba41a9faaa1c293a5fe2db6a Depends-On: Ifc5512c0e2373cf3387e0e0498268eab092e52bb Signed-off-by: Doug Hellmann <doug@doughellmann.com> 
Change-Id: Iee591504ba5d7506ba41a9faaa1c293a5fe2db6a
Depends-On: Ifc5512c0e2373cf3387e0e0498268eab092e52bb
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
doc: Remove local fork of apidoc 2017-03-28T15:29:19+00:00 Stephen Finucane sfinucan@redhat.com 2017-03-20T13:31:29+00:00 9f471eede95b7c555c4b71673806bd11943460e0 This is unnecessary as pbr has since been fixed. It was causing a broken build as it didn't respect the '[pbr] autodoc_tree_excludes' setting in setup.cfg. The 'openstackclient/volume/v3' directory is an empty module containing only an '__init__' file). Empty modules = unhappy autodoc, thus, this module is ignored. Change-Id: Ie355b14c14b7badccb5c25f7c17edbc5e4b3804f 
This is unnecessary as pbr has since been fixed. It was causing a broken
build as it didn't respect the '[pbr] autodoc_tree_excludes' setting in
setup.cfg.

The 'openstackclient/volume/v3' directory is an empty module containing
only an '__init__' file). Empty modules = unhappy autodoc, thus, this
module is ignored.

Change-Id: Ie355b14c14b7badccb5c25f7c17edbc5e4b3804f
Make the doc build reproducible 2016-07-11T12:55:12+00:00 Thomas Goirand zigo@debian.org 2016-07-11T12:53:37+00:00 393ecedc3b162ad166d2be92485ec985e8f7ae0e This fixes Debian bug: https://bugs.debian.org/826676 Change-Id: I638488448a4d6e644ab0e6deaebd65c92fa7904a 
This fixes Debian bug:
https://bugs.debian.org/826676

Change-Id: I638488448a4d6e644ab0e6deaebd65c92fa7904a
autodocument commands from plugins using stevedore.sphinxext 2015-12-01T06:23:56+00:00 Steve Martinelli stevemar@ca.ibm.com 2015-10-16T06:08:05+00:00 727792da17ac5edcfc2df7dd820dbccf318554fe conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572 
conflicting command names are a painpoint, so is manually updating
a list. let's autodocument the commands that are being use by
existing osc supporters.

Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
Fixes modules index generated by Sphinx 2015-07-10T04:40:31+00:00 lin-hua-cheng os.lcheng@gmail.com 2015-07-10T04:40:31+00:00 89cf9f61b18dff5b073fae74191fbc8447448374 Sphinx was always using (o)penstackclient for the prefix so the index wasn't very useful. Change-Id: Ie9f5d7fe428142bdb8027b422e3023418b48c428 
Sphinx was always using (o)penstackclient for the prefix so the index
wasn't very useful.

Change-Id: Ie9f5d7fe428142bdb8027b422e3023418b48c428