From: Kefu Chai Date: Sun, 21 Mar 2021 17:01:07 +0000 (+0800) Subject: doc: use :ref: instead relative path for links X-Git-Tag: v17.1.0~2523^2~1 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=1dbc93219543d78e62c4132b36cecc57ee314444;p=ceph.git 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 --- diff --git a/doc/api/index.rst b/doc/api/index.rst index e359b87f86c7..7007b0dc196a 100644 --- 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 `. +- See :ref:`Swift-compatible API `. +- See :ref:`Admin Ops API`. 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 `. .. toctree:: :hidden: diff --git a/doc/cephfs/api/index.rst b/doc/cephfs/api/index.rst index 2247610bb6d8..bb62502005b8 100644 --- 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 130a6b9a65d4..4cd81a1dcb53 100644 --- 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 f4e6836b09ed..5785bf130a30 100644 --- 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 cccc153cf1d4..8e78a999222e 100644 --- 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 2dfd9f6d9881..f73fe19107aa 100644 --- 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 c01a3e579615..cb31284e0426 100644 --- 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 9d23bfcb1981..0adfc1d59c96 100644 --- 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 2cb2dde672e2..24abd7728953 100644 --- 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 981235f87d75..dc01f2373ae9 100644 --- a/doc/rbd/api/librbdpy.rst +++ b/doc/rbd/api/librbdpy.rst @@ -1,3 +1,5 @@ +.. _rbd api py: + ================ Librbd (Python) ================