From d85b9970ce4ae3ea24d5ca02710611bd19152e3b Mon Sep 17 00:00:00 2001
From: Lucas Alvares Gomes <lucasagomes@gmail.com>
Date: Wed, 27 Jan 2016 13:39:30 +0000
Subject: [PATCH] Fix doc8's "duplicated target names" (D000) error
This patch is enabling the D000 error (duplicated target names) in doc8
and fixing the occurrences of this error in the docs.
Change-Id: Iac048d213e0571b99696ec708f5c07d6e1bebb19
---
doc/source/deploy/install-guide.rst | 28 +++++++++++++---------------
doc/source/drivers/ilo.rst | 8 ++++----
tox.ini | 2 +-
3 files changed, 18 insertions(+), 20 deletions(-)
diff --git a/doc/source/deploy/install-guide.rst b/doc/source/deploy/install-guide.rst
index 7683bc7b67..f224e4f328 100644
--- a/doc/source/deploy/install-guide.rst
+++ b/doc/source/deploy/install-guide.rst
@@ -1859,12 +1859,12 @@ in swift. HTTPS is required to encrypt all communication between swift and Ironi
conductor and swift and bare metal (via virtual media). It can be enabled in one
of the following ways:
-* Using an SSL termination proxy. For more information, `see here
+* `Using an SSL termination proxy
<http://docs.openstack.org/security-guide/secure-communication/tls-proxies-and-http-services.html>`_
-* Using native SSL support in swift (recommended only for testing
- purpose by swift). For more information,
- `see here <http://docs.openstack.org/developer/swift/deployment_guide.html>`_
+* `Using native SSL support in swift
+ <http://docs.openstack.org/developer/swift/deployment_guide.html>`_
+ (recommended only for testing purpose by swift).
Using Bare Metal service as a standalone service
================================================
@@ -2114,19 +2114,18 @@ the configuration drive and mount it, for example::
Cloud-init integration
----------------------
-The configuration drive can be especially
-useful when used with ``cloud-init`` [`link
-<http://cloudinit.readthedocs.org/en/latest/topics/datasources.html#config-drive>`_],
+The configuration drive can be
+especially useful when used with `cloud-init
+<http://cloudinit.readthedocs.org/en/latest/topics/datasources.html#config-drive>`_,
but in order to use it we should follow some rules:
-* ``Cloud-init`` expects a specific format to the data. For
- more information about the expected file layout see [`link
- <http://docs.openstack.org/user-guide/cli_config_drive.html#configuration-drive-contents>`_].
+* ``Cloud-init`` `expects a specific format to the data
+ <http://docs.openstack.org/user-guide/cli_config_drive.html#configuration-drive-contents>`_.
* Since the Bare Metal service uses a disk partition as the configuration drive,
- it will only work with ``cloud-init`` version **>= 0.7.5** [`link
- <http://bazaar.launchpad.net/~cloud-init-dev/cloud-init/trunk/view/head:/ChangeLog>`_].
+ it will only work with
+ `cloud-init version >= 0.7.5 <http://bazaar.launchpad.net/~cloud-init-dev/cloud-init/trunk/view/head:/ChangeLog>`_.
* ``Cloud-init`` has a collection of data source modules, so when
@@ -2136,9 +2135,8 @@ but in order to use it we should follow some rules:
DIB_CLOUD_INIT_DATASOURCES="ConfigDrive, OpenStack" disk-image-create -o fedora-cloud-image fedora baremetal
- See [`link
- <http://docs.openstack.org/developer/diskimage-builder/elements/cloud-init-datasources/README.html>`_]
- for more information.
+ For more information see `how to configure cloud-init data sources
+ <http://docs.openstack.org/developer/diskimage-builder/elements/cloud-init-datasources/README.html>`_.
.. _BuildingDeployRamdisk:
diff --git a/doc/source/drivers/ilo.rst b/doc/source/drivers/ilo.rst
index e0d3d049b1..19ef2e824c 100644
--- a/doc/source/drivers/ilo.rst
+++ b/doc/source/drivers/ilo.rst
@@ -56,9 +56,8 @@ Different Configuration for ilo drivers
Glance Configuration
^^^^^^^^^^^^^^^^^^^^
-1. Configure Glance image service with its storage backend as Swift. See
- `here <http://docs.openstack.org/developer/glance/configuring.html#configuring-the-swift-storage-backend>`_
- for configuration instructions.
+1. `Configure Glance image service with its storage backend as Swift
+ <http://docs.openstack.org/developer/glance/configuring.html#configuring-the-swift-storage-backend>`_.
2. Set a temp-url key for Glance user in Swift. For example, if you have
configured Glance with user ``glance-swift`` and tenant as ``service``,
@@ -640,7 +639,8 @@ To enable ``secure_boot`` on a node add it to ``capabilities`` as below::
ironic node-update <node-uuid> add properties/capabilities='secure_boot:true'
-Alternatively use `Hardware Inspection`_ to populate the secure boot capability.
+Alternatively see `Hardware Inspection Support`_ to know how to
+automatically populate the secure boot capability.
Nodes having ``secure_boot`` set to ``true`` may be requested by adding an
``extra_spec`` to the nova flavor::
diff --git a/tox.ini b/tox.ini
index 69b9200b51..b74caf5f2d 100644
--- a/tox.ini
+++ b/tox.ini
@@ -32,7 +32,7 @@ commands =
# Check that .po and .pot files are valid:
bash -c "find ironic -type f -regex '.*\.pot?' -print0|xargs -0 -n 1 msgfmt --check-format -o /dev/null"
# Check the *.rst files
- doc8 README.rst CONTRIBUTING.rst doc/source --ignore D001 --ignore D000
+ doc8 README.rst CONTRIBUTING.rst doc/source --ignore D001
[testenv:cover]
setenv = VIRTUAL_ENV={envdir}