Add an OpenStack-wide intersphinx mapping file
Change-Id: Id30470132eb9540b6f7fb693fca5ec0cbe2ce49a
Monty Taylor
10 years ago
| 0 | # Copyright (c) 2013 Hewlett-Packard Development Company, L.P. | |
| 1 | # | |
| 2 | # Licensed under the Apache License, Version 2.0 (the "License"); | |
| 3 | # you may not use this file except in compliance with the License. | |
| 4 | # You may obtain a copy of the License at | |
| 5 | # | |
| 6 | # http://www.apache.org/licenses/LICENSE-2.0 | |
| 7 | # | |
| 8 | # Unless required by applicable law or agreed to in writing, software | |
| 9 | # distributed under the License is distributed on an "AS IS" BASIS, | |
| 10 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | |
| 11 | # implied. | |
| 12 | # See the License for the specific language governing permissions and | |
| 13 | # limitations under the License. | |
| 14 | ||
| 15 | """Intersphinx mapping file for the OpenStack projects. | |
| 16 | ||
| 17 | To use this mapping in a project, first add 'sphinx.ext.intersphinx' to | |
| 18 | your extensions list in conf.py. Then:: | |
| 19 | ||
| 20 | from oslo.sphinx import intersphinx | |
| 21 | intersphinx_mapping = intersphinx.mapping | |
| 22 | ||
| 23 | You'll be able to link to other project's documentation, such as: | |
| 24 | ||
| 25 | :ref:`virtual-environments <nova:virtual-environments>` | |
| 26 | """ | |
| 27 | ||
| 28 | mapping = dict( | |
| 29 | # OpenStack Projects | |
| 30 | ceilometer=('http://docs.openstack.org/developer/ceilometer/', None), | |
| 31 | cinder=('http://docs.openstack.org/developer/cinder/', None), | |
| 32 | glance=('http://docs.openstack.org/developer/glance/', None), | |
| 33 | heat=('http://docs.openstack.org/developer/heat/', None), | |
| 34 | horizon=('http://docs.openstack.org/developer/horizon/', None), | |
| 35 | ironic=('http://docs.openstack.org/developer/ironic/', None), | |
| 36 | keystone=('http://docs.openstack.org/developer/keystone/', None), | |
| 37 | nova=('http://docs.openstack.org/developer/nova/', None), | |
| 38 | oslo_config=('http://docs.openstack.org/developer/oslo.config/', None), | |
| 39 | oslo_messaging=( | |
| 40 | 'http://docs.openstack.org/developer/oslo.messaging/', None), | |
| 41 | ceilometerclient=( | |
| 42 | 'http://docs.openstack.org/developer/python-ceilometerclient/', None), | |
| 43 | cinderclient=( | |
| 44 | 'http://docs.openstack.org/developer/python-cinderclient/', None), | |
| 45 | glanceclient=( | |
| 46 | 'http://docs.openstack.org/developer/python-glanceclient/', None), | |
| 47 | heatclient=( | |
| 48 | 'http://docs.openstack.org/developer/python-heatclient/', None), | |
| 49 | ironicclient=( | |
| 50 | 'http://docs.openstack.org/developer/python-ironicclient/', None), | |
| 51 | keystoneclient=( | |
| 52 | 'http://docs.openstack.org/developer/python-keystoneclient/', None), | |
| 53 | novaclient=( | |
| 54 | 'http://docs.openstack.org/developer/python-novaclient/', None), | |
| 55 | openstackclient=( | |
| 56 | 'http://docs.openstack.org/developer/python-openstackclient/', None), | |
| 57 | quantumclient=( | |
| 58 | 'http://docs.openstack.org/developer/python-swiftclient/', None), | |
| 59 | swiftclient=( | |
| 60 | 'http://docs.openstack.org/developer/python-swiftclient/', None), | |
| 61 | troveclient=( | |
| 62 | 'http://docs.openstack.org/developer/python-troveclient/', None), | |
| 63 | quantum=('http://docs.openstack.org/developer/quantum/', None), | |
| 64 | swift=('http://docs.openstack.org/developer/swift/', None), | |
| 65 | trove=('http://docs.openstack.org/developer/trove/', None), | |
| 66 | # Other things of note | |
| 67 | python=('http://docs.python.org/', None), | |
| 68 | infra=('http://ci.openstack.org/', None), | |
| 69 | zuul=('http://ci.openstack.org/zuul/', None), | |
| 70 | ) |