'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
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
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
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
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
Rather than host different and possibly out of date versions of
static and theme files, use oslosphinx to generate the docs.
Change-Id: I7eadc8e40aa10cc26cfd6aece6efa5d13fee70b0
To make things more consistent across all openstack projects, the
developer docs should be upgraded to the newer template used by
keystone and keystoneclient (and other projects).
I dropped in the necessary static files and themes, and updated
the config file to make the changes at build time.
Change-Id: I5a268cff3cd5af29ad712705d540b9d1d6667d56
Partial-Bug: #1331304
* rename HACKING to HACKING.rst and refer to the common OpenStack HACKING file
* add the barest of pointers to the wiki, etc. to the source docs
* add a bare-bones man page
Change-Id: I80e5b972af645f14ef17ae87f182ab09cb08dabe
To better facilitate the building and publishing of sphinx
documentation by Jenkins we are moving all openstack projects with
sphinx documentation to a common doc tree structure. Documentation
goes in project/doc/source and build results go in project/doc/build.
Change-Id: I925e687254bac9e06c2c520f4fc35a083e21c4ca
