openstack/ironic-python-agent
Code Issues Proposed changes

Use doc8 style checker

Browse Source 
This uses the doc8 style checker to check that document files
conform to certain requirements, as documented at
https://pypi.python.org/pypi/doc8.

The README was modified because it had several lines that were
were longer than 79 characters, and some links were fixed.

Change-Id: Ia21b680ec227357ada58326fea104696561475d5
This commit is contained in:
Ruby Loo
2015-09-30 23:48:46 +00:00
parent 378197caee
commit e74cd66a4b
3 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.rst
View File

@@ -3,25 +3,26 @@ ironic-python-agent
An agent for controlling and deploying Ironic controlled baremetal nodes. An agent for controlling and deploying Ironic controlled baremetal nodes.
The ironic-python-agent works with the agent driver in Ironic to provision the node. The ironic-python-agent works with the agent driver in Ironic to provision
Starting with ironic-python-agent running on a ramdisk on the unprovisioned node, the node. Starting with ironic-python-agent running on a ramdisk on the
Ironic makes API calls to ironic-python-agent to provision the machine. unprovisioned node, Ironic makes API calls to ironic-python-agent to provision
This allows for greater control and flexibility of the entire deployment process. the machine. This allows for greater control and flexibility of the entire
deployment process.
The ironic-python-agent may also be used with the original Ironic pxe drivers as of the The ironic-python-agent may also be used with the original Ironic pxe drivers
Kilo OpenStack release. as of the Kilo OpenStack release.
Building the IPA deployment ramdisk Building the IPA deployment ramdisk
================================== ===================================
See `CoreOS Image builder <https://github.com/openstack/ironic-python-agent/tree/master/imagebuild/coreos>` See `CoreOS Image builder <https://github.com/openstack/ironic-python-agent/tree/master/imagebuild/coreos>`_.
Using IPA with devstack Using IPA with devstack
======================= =======================
This is covered in the `Deploying Ironic with DevStack <http://docs.openstack.org/developer/ironic/dev/dev-quickstart.html#deploying-ironic-with-devstack>` This is covered in the `Deploying Ironic with DevStack <http://docs.openstack.org/developer/ironic/dev/dev-quickstart.html#deploying-ironic-with-devstack>`_
section of the Ironic dev-quickstart guide. section of the Ironic dev-quickstart guide.
@@ -43,4 +44,4 @@ IRC channel:
#openstack-ironic #openstack-ironic
To contribute, start here: `Openstack: How to To contribute, start here: `Openstack: How to
contribute <http://docs.openstack.org/infra/manual/developers.html>`__. contribute <http://docs.openstack.org/infra/manual/developers.html>`_.

1
test-requirements.txt
View File

@@ -10,6 +10,7 @@ testtools>=1.4.0
python-subunit>=0.0.18 python-subunit>=0.0.18
# Doc requirements # Doc requirements
doc8 # Apache-2.0
sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
sphinxcontrib-pecanwsme>=0.8 sphinxcontrib-pecanwsme>=0.8
oslosphinx>=2.5.0 # Apache-2.0 oslosphinx>=2.5.0 # Apache-2.0

1
tox.ini
View File

@@ -33,6 +33,7 @@ commands =
[testenv:pep8] [testenv:pep8]
commands = commands =
flake8 {posargs:ironic_python_agent imagebuild} flake8 {posargs:ironic_python_agent imagebuild}
doc8 doc/source README.rst
[testenv:cover] [testenv:cover]
setenv = VIRTUAL_ENV={envdir} setenv = VIRTUAL_ENV={envdir}