[DOCS] Include branch in links to role docs

Create a new external link alias for role docs to simplify adding links
for them within the deploy guide and to automatically include the
correct branch name within those links.

Closes-Bug: 1620233
Change-Id: I02a474fabe5c1a7499e828c4661cf6b232886409
This commit is contained in:
Jimmy McCrory 2017-02-14 02:15:40 -08:00
parent 7659b632b2
commit 92ccc1b8cd
2 changed files with 39 additions and 67 deletions

View File

@ -341,9 +341,11 @@ if watermark == "":
deploy_guide_prefix = "http://docs.openstack.org/project-deploy-guide/openstack-ansible/{}/%s".format(deploy_branch_link_name) deploy_guide_prefix = "http://docs.openstack.org/project-deploy-guide/openstack-ansible/{}/%s".format(deploy_branch_link_name)
dev_docs_prefix = "http://docs.openstack.org/developer/openstack-ansible/developer-docs/{}%s".format(dev_branch_link_name) dev_docs_prefix = "http://docs.openstack.org/developer/openstack-ansible/developer-docs/{}%s".format(dev_branch_link_name)
role_docs_prefix = "http://docs.openstack.org/developer/openstack-ansible-%s/{}".format(dev_branch_link_name)
extlinks = {'deploy_guide': (deploy_guide_prefix, ''), extlinks = {'deploy_guide': (deploy_guide_prefix, ''),
'dev_docs': (dev_docs_prefix, '') 'dev_docs': (dev_docs_prefix, ''),
'role_docs': (role_docs_prefix, '')
} }
# -- Options for sphinxmark ----------------------------------------------- # -- Options for sphinxmark -----------------------------------------------

View File

@ -74,115 +74,85 @@ about the available options.
Infrastructure service roles Infrastructure service roles
---------------------------- ----------------------------
- `galera_server - :role_docs:`galera_server`
<http://docs.openstack.org/developer/openstack-ansible-galera_server>`_
- `haproxy_server - :role_docs:`haproxy_server`
<http://docs.openstack.org/developer/openstack-ansible-haproxy_server>`_
- `memcached_server - :role_docs:`memcached_server`
<http://docs.openstack.org/developer/openstack-ansible-memcached_server>`_
- `rabbitmq_server - :role_docs:`rabbitmq_server`
<http://docs.openstack.org/developer/openstack-ansible-rabbitmq_server>`_
- `repo_build - :role_docs:`repo_build`
<http://docs.openstack.org/developer/openstack-ansible-repo_build>`_
- `repo_server - :role_docs:`repo_server`
<http://docs.openstack.org/developer/openstack-ansible-repo_server>`_
- `rsyslog_server - :role_docs:`rsyslog_server`
<http://docs.openstack.org/developer/openstack-ansible-rsyslog_server>`_
OpenStack service roles OpenStack service roles
----------------------- -----------------------
- `os_aodh <http://docs.openstack.org/developer/openstack-ansible-os_aodh>`_ - :role_docs:`os_aodh`
- `os_barbican - :role_docs:`os_barbican`
<http://docs.openstack.org/developer/openstack-ansible-os_barbican>`_
- `os_ceilometer - :role_docs:`os_ceilometer`
<http://docs.openstack.org/developer/openstack-ansible-os_ceilometer>`_
- `os_cinder - :role_docs:`os_cinder`
<http://docs.openstack.org/developer/openstack-ansible-os_cinder>`_
- `os_designate - :role_docs:`os_designate`
<http://docs.openstack.org/developer/openstack-ansible-os_designate>`_
- `os_glance - :role_docs:`os_glance`
<http://docs.openstack.org/developer/openstack-ansible-os_glance>`_
- `os_gnocchi - :role_docs:`os_gnocchi`
<http://docs.openstack.org/developer/openstack-ansible-os_gnocchi>`_
- `os_heat <http://docs.openstack.org/developer/openstack-ansible-os_heat>`_ - :role_docs:`os_heat`
- `os_horizon - :role_docs:`os_horizon`
<http://docs.openstack.org/developer/openstack-ansible-os_horizon>`_
- `os_ironic - :role_docs:`os_ironic`
<http://docs.openstack.org/developer/openstack-ansible-os_ironic>`_
- `os_keystone - :role_docs:`os_keystone`
<http://docs.openstack.org/developer/openstack-ansible-os_keystone>`_
- `os_magnum - :role_docs:`os_magnum`
<http://docs.openstack.org/developer/openstack-ansible-os_magnum>`_
- `os_neutron - :role_docs:`os_neutron`
<http://docs.openstack.org/developer/openstack-ansible-os_neutron>`_
- `os_nova <http://docs.openstack.org/developer/openstack-ansible-os_nova>`_ - :role_docs:`os_nova`
- `os_rally <http://docs.openstack.org/developer/openstack-ansible-os_rally>`_ - :role_docs:`os_rally`
- `os_sahara - :role_docs:`os_sahara`
<http://docs.openstack.org/developer/openstack-ansible-os_sahara>`_
- `os_swift <http://docs.openstack.org/developer/openstack-ansible-os_swift>`_ - :role_docs:`os_swift`
- `os_tempest - :role_docs:`os_tempest`
<http://docs.openstack.org/developer/openstack-ansible-os_tempest>`_
- `os_trove <http://docs.openstack.org/developer/openstack-ansible-os_trove>`_ - :role_docs:`os_trove`
Other roles Other roles
----------- -----------
- `ansible-plugins - :role_docs:`ansible-plugins`
<http://docs.openstack.org/developer/openstack-ansible-plugins>`_
- `apt_package_pinning - :role_docs:`apt_package_pinning`
<http://docs.openstack.org/developer/openstack-ansible-apt_package_pinning/>`_
- `ceph_client - :role_docs:`ceph_client`
<http://docs.openstack.org/developer/openstack-ansible-ceph_client>`_
- `galera_client - :role_docs:`galera_client`
<http://docs.openstack.org/developer/openstack-ansible-galera_client>`_
- `lxc_container_create - :role_docs:`lxc_container_create`
<http://docs.openstack.org/developer/openstack-ansible-lxc_container_create>`_
- `lxc_hosts - :role_docs:`lxc_hosts`
<http://docs.openstack.org/developer/openstack-ansible-lxc_hosts>`_
- `pip_install - :role_docs:`pip_install`
<http://docs.openstack.org/developer/openstack-ansible-pip_install/>`_
- `openstack_openrc - :role_docs:`openstack_openrc`
<http://docs.openstack.org/developer/openstack-ansible-openstack_openrc>`_
- `openstack_hosts - :role_docs:`openstack_hosts`
<http://docs.openstack.org/developer/openstack-ansible-openstack_hosts>`_
- `rsyslog_client - :role_docs:`rsyslog_client`
<http://docs.openstack.org/developer/openstack-ansible-rsyslog_client>`_
Configuring service credentials Configuring service credentials
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~