F5Networks / f5-openstack-lbaasv1

OpenStack Neutron LBaaSv1 plugin and agent to control F5 BIG-IP devices
http://f5-openstack-lbaasv1.readthedocs.io
6 stars 8 forks source link

Update intersphinx mapping settings to point to corresponding version(s) in external doc sets #107

Closed jputrino closed 6 years ago

jputrino commented 8 years ago

Agent Version

8.0.2

OpenStack Release

Kilo +

Description

Intersphinx mapping settings in docs/conf.py need to point to specific versions which correspond to the version of the lbaasv1 doc from which the clicks the link out to the other doc set.

For Kilo:

intersphinx_mapping = {'heat': (
     'http://f5-openstack-docs.readthedocs.io/en/1.0/', None),
     'docs': (
     'http://f5-openstack-docs.readthedocs.io/en/1.0/', None),
     #'lbaasv2': (
     #'http://f5-openstack-docs.readthedocs.io/en/1.0/', None), \\ commented out because there is no corresponding branch in lbaasv2
     }

For Liberty:

intersphinx_mapping = {'heat': (
     'http://f5-openstack-docs.readthedocs.io/en/liberty/', None),
     'docs': (
     'http://f5-openstack-docs.readthedocs.io/en/liberty/', None),
     'lbaasv2': (
     'http://f5-openstack-docs.readthedocs.io/en/liberty/', None),
     }

For Mitaka:

intersphinx_mapping = {'heat': (
     'http://f5-openstack-docs.readthedocs.io/en/mitaka/', None),
     'docs': (
     'http://f5-openstack-docs.readthedocs.io/en/mitaka/', None),
     'lbaasv2': (
     'http://f5-openstack-docs.readthedocs.io/en/mitaka/', None),
     }