diff options
| author | Stephen Finucane <sfinucan@redhat.com> | 2018-02-05 15:15:34 +0000 |
|---|---|---|
| committer | Stephen Finucane <sfinucan@redhat.com> | 2018-05-03 14:34:47 +0100 |
| commit | dd1a416bc92432160584693f13ccca3f3b57f5de (patch) | |
| tree | c4dc0dc65c6f6ac9ae0237532e0db677a2379948 /placement-api-ref | |
| parent | fcdc61a18aeefe3930457f1a1f47993e64fb5eb4 (diff) | |
| download | nova-dd1a416bc92432160584693f13ccca3f3b57f5de.tar.gz | |
doc: Start using openstackdoctheme's extlink extension
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.
[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper
Change-Id: Ifb99e727110c4904a85bc4a13366c2cae300b8df
Diffstat (limited to 'placement-api-ref')
| -rw-r--r-- | placement-api-ref/source/conf.py | 6 | ||||
| -rw-r--r-- | placement-api-ref/source/index.rst | 4 |
2 files changed, 8 insertions, 2 deletions
diff --git a/placement-api-ref/source/conf.py b/placement-api-ref/source/conf.py index 536f02cdd0..f52d3fdbd0 100644 --- a/placement-api-ref/source/conf.py +++ b/placement-api-ref/source/conf.py @@ -88,3 +88,9 @@ latex_documents = [ ('index', 'Placement.tex', u'OpenStack Placement API Documentation', u'OpenStack Foundation', 'manual'), ] + +# -- Options for openstackdocstheme ------------------------------------------- + +openstack_projects = [ + 'nova', +] diff --git a/placement-api-ref/source/index.rst b/placement-api-ref/source/index.rst index fe0feee27f..d09315b8ef 100644 --- a/placement-api-ref/source/index.rst +++ b/placement-api-ref/source/index.rst @@ -5,8 +5,8 @@ =============== This is a reference for the OpenStack Placement API. To learn more about -OpenStack Placement API concepts, please refer to the -`Placement Introduction <https://docs.openstack.org/nova/latest/user/placement.html>`_. +OpenStack Placement API concepts, please refer to the :nova-doc:`Placement +Introduction <user/placement.html>`. The Placement API uses JSON for data exchange. As such, the ``Content-Type`` header for APIs sending data payloads in the request body (i.e. ``PUT`` and |