The api reference was broken some time around the stein release.
Moved conf options out of setup.cfg and into the doc conf.py, and added
an option to doc build to error on warnings so this doesn't happen
again without anyone noticing. The format is now similar to the
novaclient reference doc.
Change-Id: Ic9ed059521794acf1ac1a644096fdc10549fa91b
Switch to openstackdocstheme 2.2.0 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.
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.
See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html
Change-Id: I6bac230569a89c055115c852d5cc0cae027cddd8
Make a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
know about the requirement
- Remove obsolete sections from setup.cfg:
* Wheel is not needed for python 3 only repo
* Some other sections are obsolete
- Update classifiers
- Update requirements, no need for python_version anymore
- Remove html_last_updated_fmt from conf.py, this is not needed with
openstackdocstheme anymore; update openstackdocstheme requirement
Change-Id: I5389ba08c985e023643c07adf3135809c291146f
The documentation build does not generate any module index,
therefore modified setup.cfg to create module index.
Change-Id: I6140896d5779e8360c866267601713bbf572fee4
* Improve index page to explain the difference between v1 and v2
CLI support.
* Add a v2 examples page
* Add all supported commands to v2 shell page
* Add a tox task to build the docs
* Fix a bug building the docs with an invalid html_static_path
config
Change-Id: Ie1e65c2d0cc8ad1b8b258e03114e19a943d1d19c
Closes-Bug: 1572217
OpenStack has dropped the incubation notion, so labeling this as an
incubated project in the docs is confusing.
Change-Id: Icf6d89805db56a4f695ac55e6630b804f26655f8
