Examples in this section should use a Python 3 environment and not py27. Change-Id: If082b92e089af980e411b4b4c1319e462862a55f Closes-Bug: #1866375
"myvol.delete" should be "myvol.delete()" Change-Id: Iadddfed8deec1f0dee2b71effb3b4de2689d6ada Closes-Bug: #1866374
os-testr is dead. Long live stestr. Change-Id: Ie37f00e2f5ef2230adcff0d662e2d0b214b8c74c Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
This adds doc8 to the pep8 job to lint the docs. Also fixes a few issues it highlighted. Change-Id: Id0f4b9bee1f6a0103ec581b20037a9b74201aaca Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
Our CLI docs are very out of date. These used to be generated by the docs team with some tooling they had. Since the docs moved in-repo, that tooling has gone away, and for the most part no one has done any updates to the CLI docs. This adds a sphinx directive that will generate these docs every time the docs are built. This way, whenever someone makes a CLI change, they do not need to have to know to also edit a documentation file to match their change. Any code changes will automatically be picked up and reflected in the docs. Change-Id: I4406872ab6e9335e338b710e492171580df74fa5 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
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. A couple of variables are also not needed anymore, remove them. Set openstackdocs_auto_name to use project as name. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. 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: I2cc022495b162bec1424ec69611acb879900c005