Reformat the documentations external references

[noissue]
pulp · Aug 26, 2020 · 768505e · 768505e
1 parent caebe8d
commit 768505e
Show file tree

Hide file tree

Showing 4 changed files with 37 additions and 25 deletions.
diff --git a/docs/bindings.rst b/docs/bindings.rst
@@ -7,20 +7,20 @@ Client Bindings
 Python Client
 --------------------------------------------------------------------------------
 
-The `pulp-deb-client package`_ on PyPI provides bindings for all API calls in the `pulp_deb REST API`_.
+The `pulp-deb-client package`_ on PyPI provides bindings for all ``pulp_deb`` :ref:`REST API <rest_api>` endpoints.
 It is currently published daily and with every RC.
 
-The `pulpcore-client package`_ on PyPI provides bindings for all API calls in the `pulpcore REST API`_.
+The `pulpcore-client package`_ on PyPI provides bindings for all pulpcore :ref:`REST API <rest_api>` endpoints.
 It is currently published daily and with every RC.
 
 
 Ruby Client
 --------------------------------------------------------------------------------
 
-The `pulp_deb_client Ruby Gem`_ on rubygems.org provides bindings for all API calls in the `pulp_deb REST API`_.
+The `pulp_deb_client Ruby Gem`_ on rubygems.org provides bindings for all ``pulp_deb`` :ref:`REST API <rest_api>` endpoints.
 It is currently published daily and with every RC.
 
-The `pulpcore_client Ruby Gem`_ on rubygems.org provides bindings for all API calls in the `pulpcore REST API`_.
+The `pulpcore_client Ruby Gem`_ on rubygems.org provides bindings for all pulpcore :ref:`REST API <rest_api>` endpoints.
 It is currently published daily and with every RC.
 
 

diff --git a/docs/external_references.rst b/docs/external_references.rst
@@ -1,16 +1,28 @@
-.. _pulp_deb REST API:        restapi.html
-.. _pulpcore REST API:        https://docs.pulpproject.org/restapi.html
-.. _pulpcore documentation:   https://docs.pulpproject.org
-.. _pulpcore installation:    https://docs.pulpproject.org/installation/index.html
-.. _Pulp project:             https://pulpproject.org
-.. _pulpcore python package:  https://pypi.org/project/pulpcore
-.. _pulpcore-client package:  https://pypi.org/project/pulpcore-client
-.. _pulp-deb-client package:  https://pypi.org/project/pulp-deb-client
-.. _pulpcore_client Ruby Gem: https://rubygems.org/gems/pulpcore_client
-.. _pulp_deb_client Ruby Gem: https://rubygems.org/gems/pulp_deb_client
-.. _OpenAPI generators:       https://openapi-generator.tech/docs/generators
-.. _try OpenAPI generator:    https://openapi-generator.tech/#try
-.. _pulplift:                 https://github.com/pulp/pulplift
-.. _pulp installer:           https://github.com/pulp/pulp_installer
-.. _httpie:                   https://httpie.org/doc
-.. _nginx.org:                https://nginx.org/en/linux_packages.html#Debian
+.. _pulpcore documentation:
+   https://docs.pulpproject.org
+.. _pulpcore installation:
+   https://docs.pulpproject.org/installation/index.html
+.. _Pulp project:
+   https://pulpproject.org
+.. _pulpcore python package:
+   https://pypi.org/project/pulpcore
+.. _pulpcore-client package:
+   https://pypi.org/project/pulpcore-client
+.. _pulp-deb-client package:
+   https://pypi.org/project/pulp-deb-client
+.. _pulpcore_client Ruby Gem:
+   https://rubygems.org/gems/pulpcore_client
+.. _pulp_deb_client Ruby Gem:
+   https://rubygems.org/gems/pulp_deb_client
+.. _OpenAPI generators:
+   https://openapi-generator.tech/docs/generators
+.. _try OpenAPI generator:
+   https://openapi-generator.tech/#try
+.. _pulplift:
+   https://github.com/pulp/pulplift
+.. _pulp installer:
+   https://github.com/pulp/pulp_installer
+.. _httpie:
+   https://httpie.org/doc
+.. _nginx.org:
+   https://nginx.org/en/linux_packages.html#Debian
diff --git a/docs/index.rst b/docs/index.rst
@@ -8,7 +8,7 @@ This plugin is a part of the `Pulp Project`_, and assumes some familiarity with
 
 If you are just getting started, we recommend getting to know the :doc:`basic workflows <workflows>`.
 
-See the `pulp_deb REST API`_ documentation for the full feature set of the ``pulp_deb`` plugin.
+See the :ref:`REST API <rest_api>` documentation for the full feature set of the ``pulp_deb`` plugin.
 
 
 Table of Contents

diff --git a/docs/rest_api.rst b/docs/rest_api.rst
@@ -1,13 +1,13 @@
+.. _rest_api:
+
 REST API
 ================================================================================
 
-.. include:: external_references.rst
-
 Pulp is strongly REST API driven.
 The REST API documentation for both pulpcore and the ``pulp_deb`` plugin are automatically generated.
 They provide a full documentation for every option of every API endpoint.
 
 The latest REST API documentation for pulpcore and ``pulp_deb`` may be found here:
 
-* `pulpcore REST API`_
-* `pulp_deb REST API`_
+* `pulpcore REST API documentation <https://docs.pulpproject.org/restapi.html>`_
+* `pulp_deb REST API documentation <restapi.html>`_