Added a testing page to the documentation.
This includes information on:
* Running PEP8 checks
* Running unit tests
* Running functional tests
Closes-bug:#1511731
Change-Id: I4a5cf4be98f32455e36ea7d6a45b18afca043809
This uses the doc8 style checker to check that document
files conform to certain requirements, as documented at
https://pypi.python.org/pypi/doc8.
Some files were modified because they had lines that
were longer than 79 characters.
Change-Id: I94e081e197898359676821cfcf8cb1133ed28bc5
This is basically a revert of commit:
af741ec2236619880fa902d68aef4a6ae6cef534
It was decided that only files that need to have the line:
# -*- coding: utf-8 -*-
Should have the line[1] as a general principle
This patch removes the 'utf-8' coding line from files that consist
entirely of ASCII characters.
[1]
http://eavesdrop.openstack.org/meetings/ironic/2015/ironic.2015-04-20-17.00.html
Partial-bug: #1325193
Change-Id: I88c1c37f7b580aa805eae9d4a1e66d33302a325f
In the 'ironicclient Python API' page, the credential section has a little
mistake in the example. It's missing "," in the first line and a '}'
in the last. You can see it at
http://docs.openstack.org/developer/python-ironicclient/api_v1.html
Change-Id: I195f46ca7261390b0d6321bc6bdd7e8d0908af40
Replace URLs for workflow documentation to appropriate parts of the
OpenStack Project Infrastructure Manual.
Dropped sections that duplicate each other after the change.
Co-Authored-By: David Shrewsbury <shrewsbury.dave@gmail.com>
Change-Id: I0642c49567a58797fd811864e95b2d9b4ed21efc
Getting rid of a couple of warnings that are generated during the
documentation build.
Closes-Bug: #1392780
Change-Id: I2ebc8f1ec49ff80331077a653f0e73c988153898
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
This updates the CLI documentation to:
- document the OS_REGION_NAME variable
- add a link to the locatin of the tools/ironic.bash-completion file because
I don't know how/where the user can get it otherwise
Change-Id: I14fe729630cb9b7da298edcb941087a1fe73d41b
This commit adds the 'bash-completion' option to
ironic cli which prints all sub-commands and
options, and bash_completion scripts for bash
auto completion.
Change-Id: Ide5b29e262b4217046f124d86902cd0abfdab1b6
Closes-Bug: 1332408
Adds some documentation on how to use the ironicclient API. Describes how
to get a client object and has examples of a few ironic operations.
The ironicclient modules are listed.
Change-Id: Ic7c739fb5722b40c308b90c27178d937cad41028
Partial-Bug: #1300990
Adds documentation for contributors, which describes how to
get started. It mentions licence agreement, launchpad ID, and
includes links to project-related information.
Change-Id: I47423c9f2cdfd708c8cb45d4284c5af16d598153
Partial-Bug: #1300990
This adds the main ('index') page for developers (to be available
at http://docs.openstack.org/developer/python-ironicclient/).
It has minimal information, and is a place holder so that we can
start adding documentation.
This also fixes issues with 'python setup.py build_sphinx':
- was getting "error: 'source_dir' must be a directory name"
because sphinx 1.2b3 was being installed instead of 1.1.2
(see https://bugs.launchpad.net/openstack-ci/+bug/1259511)
- was getting "sphinx.errors.ExtensionError: Could not import
extension oslo.sphinx (exception: No module named sphinx)"
- was complaining about missing '_theme' (oslosphinx has the theme)
Change-Id: I47ad7e10c20b80a99ae36755b2f7f67c080676fd
Partial-Bug: #1300990
