openstack/openstack-ansible
Code Issues Proposed changes

Fix 'D000: Check RST validity' documentation lint failures

Browse Source 
Implements: blueprint osa-install-guide-overhaul
Change-Id: I8d7873890fab7f75a47313971015ff2cb06f0f25
This commit is contained in:
Alexandra 2016-07-14 13:53:17 +01:00 committed by Jesse Pretorius (odyssey4me)
parent 30dacdf8af
commit 993515c85f
14 changed files with 22 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/developer-docs/configure-keystone.rst
View File

@ -112,7 +112,7 @@ keystone section.
More details regarding valid configuration for the LDAP Identity backend can More details regarding valid configuration for the LDAP Identity backend can
be found in the `Keystone Developer Documentation`_ and the be found in the `Keystone Developer Documentation`_ and the
`OpenStack Admin Guide`_. `OpenStack Administrator Guide`_.
.. _Keystone Developer Documentation: http://docs.openstack.org/developer/keystone/configuration.html#configuring-the-ldap-identity-provider .. _Keystone Developer Documentation: http://docs.openstack.org/developer/keystone/configuration.html#configuring-the-ldap-identity-provider
.. _OpenStack Administrator Guide: http://docs.openstack.org/admin-guide/keystone_integrate_identity_backend_ldap.html .. _OpenStack Administrator Guide: http://docs.openstack.org/admin-guide/keystone_integrate_identity_backend_ldap.html

4
doc/source/install-guide-revised-draft/app-configfiles.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
=============================== ================================
Appendix A: Configuration files Appendix A: Configuration files
=============================== ================================
`openstack_user_config.yml `openstack_user_config.yml
<https://raw.githubusercontent.com/openstack/openstack-ansible/master/etc/openstack_deploy/openstack_user_config.yml.example>`_ <https://raw.githubusercontent.com/openstack/openstack-ansible/master/etc/openstack_deploy/openstack_user_config.yml.example>`_

4
doc/source/install-guide-revised-draft/app-custom-layouts.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
================================================ =================================================
Appendix E: Customizing host and service layouts Appendix E: Customizing host and service layouts
================================================ =================================================
Understanding the default layout Understanding the default layout
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

4
doc/source/install-guide-revised-draft/app-plumgrid.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`__ OpenStack-Ansible Installation Guide `Home <index.html>`__ OpenStack-Ansible Installation Guide
========================================= ==========================================
Appendix D: Using PLUMgrid Neutron plugin Appendix D: Using PLUMgrid Neutron plugin
========================================= ==========================================
Installing source and host networking Installing source and host networking
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

4
doc/source/install-guide-revised-draft/app-resources.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
================================ =================================
Appendix B: Additional resources Appendix B: Additional resources
================================ =================================
The following Ansible resources are useful to reference: The following Ansible resources are useful to reference:

2
doc/source/install-guide-revised-draft/configure-sslcertificates.rst
View File

@ -102,7 +102,7 @@ User-provided certificates
You can provide your own SSL certificates, keys, and CA certificates You can provide your own SSL certificates, keys, and CA certificates
for added trust in highly secure environments. Acquiring certificates from a for added trust in highly secure environments. Acquiring certificates from a
trusted certificate authority is outside the scope of this document, but the trusted certificate authority is outside the scope of this document, but the
`Certificate Management`_ section of the Linux Documentation Project explains `Certificate Management`_ section of the Linux Documentation Project explains
how to create your own certificate authority and sign certificates. how to create your own certificate authority and sign certificates.
.. _Certificate Management: http://www.tldp.org/HOWTO/SSL-Certificates-HOWTO/c118.html .. _Certificate Management: http://www.tldp.org/HOWTO/SSL-Certificates-HOWTO/c118.html

4
doc/source/install-guide-revised-draft/overview.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
=================== ====================
Chapter 1. Overview Chapter 1. Overview
=================== ====================
.. toctree:: .. toctree::

4
doc/source/install-guide/app-configfiles.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
=============================== ================================
Appendix A: Configuration files Appendix A: Configuration files
=============================== ================================
`openstack_user_config.yml `openstack_user_config.yml
<https://raw.githubusercontent.com/openstack/openstack-ansible/master/etc/openstack_deploy/openstack_user_config.yml.example>`_ <https://raw.githubusercontent.com/openstack/openstack-ansible/master/etc/openstack_deploy/openstack_user_config.yml.example>`_

4
doc/source/install-guide/app-plumgrid.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`__ OpenStack-Ansible Installation Guide `Home <index.html>`__ OpenStack-Ansible Installation Guide
========================================= ==========================================
Appendix E: Using PLUMgrid Neutron plugin Appendix E: Using PLUMgrid Neutron plugin
========================================= ==========================================
Installing source and host networking Installing source and host networking
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

4
doc/source/install-guide/app-resources.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
================================ =================================
Appendix B: Additional resources Appendix B: Additional resources
================================ =================================
The following Ansible resources are useful to reference: The following Ansible resources are useful to reference:

2
doc/source/install-guide/configure-keystone.rst
View File

@ -112,7 +112,7 @@ keystone section.
More details regarding valid configuration for the LDAP Identity backend can More details regarding valid configuration for the LDAP Identity backend can
be found in the `Keystone Developer Documentation`_ and the be found in the `Keystone Developer Documentation`_ and the
`OpenStack Admin Guide`_. `OpenStack Administrator Guide`_.
.. _Keystone Developer Documentation: http://docs.openstack.org/developer/keystone/configuration.html#configuring-the-ldap-identity-provider .. _Keystone Developer Documentation: http://docs.openstack.org/developer/keystone/configuration.html#configuring-the-ldap-identity-provider
.. _OpenStack Administrator Guide: http://docs.openstack.org/admin-guide/keystone_integrate_identity_backend_ldap.html .. _OpenStack Administrator Guide: http://docs.openstack.org/admin-guide/keystone_integrate_identity_backend_ldap.html

2
doc/source/install-guide/configure-sslcertificates.rst
View File

@ -102,7 +102,7 @@ User-provided certificates
You can provide your own SSL certificates, keys, and CA certificates You can provide your own SSL certificates, keys, and CA certificates
for added trust in highly secure environments. Acquiring certificates from a for added trust in highly secure environments. Acquiring certificates from a
trusted certificate authority is outside the scope of this document, but the trusted certificate authority is outside the scope of this document, but the
`Certificate Management`_ section of the Linux Documentation Project explains `Certificate Management`_ section of the Linux Documentation Project explains
how to create your own certificate authority and sign certificates. how to create your own certificate authority and sign certificates.
.. _Certificate Management: http://www.tldp.org/HOWTO/SSL-Certificates-HOWTO/c118.html .. _Certificate Management: http://www.tldp.org/HOWTO/SSL-Certificates-HOWTO/c118.html

4
doc/source/install-guide/overview.rst
View File

@ -1,8 +1,8 @@
`Home <index.html>`_ OpenStack-Ansible Installation Guide `Home <index.html>`_ OpenStack-Ansible Installation Guide
=================== ====================
Chapter 1. Overview Chapter 1. Overview
=================== ====================
.. toctree:: .. toctree::

3
tox.ini
View File

@ -37,9 +37,6 @@ commands=
[doc8] [doc8]
# Settings for doc8: # Settings for doc8:
extensions = .rst extensions = .rst
# Disable some doc8 checks:
# D000: Check RST validity
ignore = D000
[testenv:releasenotes] [testenv:releasenotes]
# NOTE(sdague): this target does not use constraints because # NOTE(sdague): this target does not use constraints because