diff --git a/README.rst b/README.rst index 4d1de9549..2c99b7ab5 100644 --- a/README.rst +++ b/README.rst @@ -3,25 +3,26 @@ ironic-python-agent 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. -Starting with ironic-python-agent running on a ramdisk on the unprovisioned node, -Ironic makes API calls to ironic-python-agent to provision the machine. -This allows for greater control and flexibility of the entire deployment process. +The ironic-python-agent works with the agent driver in Ironic to provision +the node. Starting with ironic-python-agent running on a ramdisk on the +unprovisioned node, Ironic makes API calls to ironic-python-agent to provision +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 -Kilo OpenStack release. +The ironic-python-agent may also be used with the original Ironic pxe drivers +as of the Kilo OpenStack release. Building the IPA deployment ramdisk -================================== +=================================== -See `CoreOS Image builder ` +See `CoreOS Image builder `_. Using IPA with devstack ======================= -This is covered in the `Deploying Ironic with DevStack ` +This is covered in the `Deploying Ironic with DevStack `_ section of the Ironic dev-quickstart guide. @@ -43,4 +44,4 @@ IRC channel: #openstack-ironic To contribute, start here: `Openstack: How to -contribute `__. +contribute `_. diff --git a/test-requirements.txt b/test-requirements.txt index 555eef77e..fc2989243 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -10,6 +10,7 @@ testtools>=1.4.0 python-subunit>=0.0.18 # Doc requirements +doc8 # Apache-2.0 sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 sphinxcontrib-pecanwsme>=0.8 oslosphinx>=2.5.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index de1dfcb18..28c6c904d 100644 --- a/tox.ini +++ b/tox.ini @@ -33,6 +33,7 @@ commands = [testenv:pep8] commands = flake8 {posargs:ironic_python_agent imagebuild} + doc8 doc/source README.rst [testenv:cover] setenv = VIRTUAL_ENV={envdir}