delta/openstack/python-openstackclient.git/doc/source/conf.py, branch pike-eol

Start using 'cliff.sphinxext'

2017-07-21T14:48:44+00:00

'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

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

Change-Id: Iee591504ba5d7506ba41a9faaa1c293a5fe2db6a
Depends-On: Ifc5512c0e2373cf3387e0e0498268eab092e52bb
Signed-off-by: Doug Hellmann

doc: Remove local fork of apidoc

2017-03-28T15:29:19+00:00

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

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

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

Sphinx was always using (o)penstackclient for the prefix so the index
wasn't very useful.

Change-Id: Ie9f5d7fe428142bdb8027b422e3023418b48c428

Enhance the theming for modules page

2014-11-19T03:07:57+00:00

Also fixes a few small docstring syntax errors

Change-Id: I85eb968e32c1191cf5d60d02deff2ab7f3291074

Stop using intersphinx

2014-09-13T07:46:09+00:00

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

Use oslosphinx to generate documentation

2014-08-05T05:31:20+00:00

Rather than host different and possibly out of date versions of
static and theme files, use oslosphinx to generate the docs.

Change-Id: I7eadc8e40aa10cc26cfd6aece6efa5d13fee70b0