doc: use :ref: instead relative path for links

path is fragile when we move the file around, but link is more stable.

Signed-off-by: Kefu Chai <kchai@redhat.com>

diff --git a/doc/api/index.rst b/doc/api/index.rst
index e359b87f86c792d789b43a680c8ba83f66772820..7007b0dc196a29824b121feae6b169514b2965ba 100644 (file)
--- a/doc/api/index.rst
+++ b/doc/api/index.rst
@@ -5,56 +5,41 @@
 Ceph RESTful API
 ================
 
-See `Ceph REST API`_.
-
-.. _Ceph REST API: ../mgr/ceph_api/
+See :ref:`mgr ceph api`.
 
 Ceph Storage Cluster APIs
 =========================
 
-See `Ceph Storage Cluster APIs`_.
-
-.. _Ceph Storage Cluster APIs: ../rados/api/
+See :ref:`rados api`
 
 
 Ceph File System APIs
 =====================
 
-See `libcephfs`_
+See :ref:`cephfs api`
 
-.. _libcephfs: ../cephfs/api
 
 Ceph Block Device APIs
 ======================
 
-See `librbdpy`_.
-
-.. _librbdpy: ../rbd/api/librbdpy
+See :ref:`rbd api py`
 
 Ceph RADOS Gateway APIs
 =======================
 
-See `librgw-py`_.
-
-.. _librgw-py: ../radosgw/api
+See :ref:`radosgw api`
 
 Ceph Object Store APIs
 ======================
 
-- See `S3-compatible API`_.
-- See `Swift-compatible API`_.
-- See `Admin Ops API`_.
+- See :ref:`S3-compatible API <radosgw s3>`.
+- See :ref:`Swift-compatible API <radosgw swift>`.
+- See :ref:`Admin Ops API<radosgw admin ops>`.
 
 Ceph MON Command API
 ====================
 
-- See `Mon command API`_.
-
-.. _S3-compatible API: ../radosgw/s3/
-.. _Swift-compatible API: ../radosgw/swift/
-.. _Admin Ops API: ../radosgw/adminops
-.. _Mon command API: mon_command_api
-
+- See :doc:`Mon command API <mon_command_api>`.
 
 .. toctree::
     :hidden:

diff --git a/doc/cephfs/api/index.rst b/doc/cephfs/api/index.rst
index 2247610bb6d8f51e96730ab7c4dea3ee4a83cf9e..bb62502005b8fa7fbb7a653d0c4b2a672c2c64cf 100644 (file)
--- a/doc/cephfs/api/index.rst
+++ b/doc/cephfs/api/index.rst
@@ -1,3 +1,5 @@
+.. _cephfs api:
+
 ============
  CephFS APIs
 ============

diff --git a/doc/dev/developer_guide/dash-devel.rst b/doc/dev/developer_guide/dash-devel.rst
index 130a6b9a65d40e74368d90f1193222e918a246ed..4cd81a1dcb53bf798eff8c9fa89e435d884c0876 100644 (file)
--- a/doc/dev/developer_guide/dash-devel.rst
+++ b/doc/dev/developer_guide/dash-devel.rst
@@ -2136,7 +2136,7 @@ REST API documentation
 ~~~~~~~~~~~~~~~~~~~~~~
 Ceph-Dashboard provides two types of documentation for the **Ceph RESTful API**:
 
-* **Static documentation**: available at :ref:`mgr-ceph-api`. This comes from a versioned specification located at ``src/pybind/mgr/dashboard/openapi.yaml``.
+* **Static documentation**: available at :ref:`mgr ceph api`. This comes from a versioned specification located at ``src/pybind/mgr/dashboard/openapi.yaml``.
 * **Interactive documentation**: available from a running Ceph-Dashboard instance (top-right ``?`` icon > API Docs).
 
 If changes are made to the ``controllers/`` directory, it's very likely that

diff --git a/doc/mgr/ceph_api/index.rst b/doc/mgr/ceph_api/index.rst
index f4e6836b09edfeb2d1050dad4fcd729ecbabecf2..5785bf130a306d53acaf3a3db146ed6062ee8ff0 100644 (file)
--- a/doc/mgr/ceph_api/index.rst
+++ b/doc/mgr/ceph_api/index.rst
@@ -1,4 +1,4 @@
-.. _mgr-ceph-api:
+.. _mgr ceph api:
 
 ================
 Ceph RESTful API

diff --git a/doc/rados/api/index.rst b/doc/rados/api/index.rst
index cccc153cf1d47caf19fa743c875dfb8df4e43aae..8e78a999222e1ab43796b7467abe379d20bb8dd4 100644 (file)
--- a/doc/rados/api/index.rst
+++ b/doc/rados/api/index.rst
@@ -1,3 +1,5 @@
+.. _rados api:
+
 ===========================
  Ceph Storage Cluster APIs
 ===========================

diff --git a/doc/radosgw/adminops.rst b/doc/radosgw/adminops.rst
index 2dfd9f6d988171e9256b95b4384c499c86ec07a8..f73fe19107aa303858dcaba467179c485241c43e 100644 (file)
--- a/doc/radosgw/adminops.rst
+++ b/doc/radosgw/adminops.rst
@@ -1,3 +1,5 @@
+.. _radosgw admin ops:
+
 ==================
  Admin Operations
 ==================

diff --git a/doc/radosgw/api.rst b/doc/radosgw/api.rst
index c01a3e5796156fd65d278fd9429d0dcc88abd7e5..cb31284e04264584f7df43e29e0087c33613d40b 100644 (file)
--- a/doc/radosgw/api.rst
+++ b/doc/radosgw/api.rst
@@ -1,3 +1,5 @@
+.. _radosgw api:
+
 ===============
 librgw (Python)
 ===============

diff --git a/doc/radosgw/s3.rst b/doc/radosgw/s3.rst
index 9d23bfcb1981839d607ceec5ffdf637fd45986ef..0adfc1d59c9693f3f73006bef30520c129545251 100644 (file)
--- a/doc/radosgw/s3.rst
+++ b/doc/radosgw/s3.rst
@@ -1,3 +1,5 @@
+.. _radosgw s3:
+
 ============================
  Ceph Object Gateway S3 API
 ============================

diff --git a/doc/radosgw/swift.rst b/doc/radosgw/swift.rst
index 2cb2dde672e2bd66ec7566333b4d39301ab5b7ae..24abd77289539b62ccabee48c405b180a431a6ea 100644 (file)
--- a/doc/radosgw/swift.rst
+++ b/doc/radosgw/swift.rst
@@ -1,3 +1,5 @@
+.. _radosgw swift:
+
 ===============================
  Ceph Object Gateway Swift API
 ===============================

diff --git a/doc/rbd/api/librbdpy.rst b/doc/rbd/api/librbdpy.rst
index 981235f87d7545a33feccc927fc96329116f91ec..dc01f2373ae934a8177cbe2588c91d5dc48a5c4d 100644 (file)
--- a/doc/rbd/api/librbdpy.rst
+++ b/doc/rbd/api/librbdpy.rst
@@ -1,3 +1,5 @@
+.. _rbd api py:
+
 ================
  Librbd (Python)
 ================