diff options
Diffstat (limited to 'src/ceph/doc/api')
-rw-r--r-- | src/ceph/doc/api/index.rst | 45 | ||||
-rw-r--r-- | src/ceph/doc/api/libcephfs-java.rst | 9 |
2 files changed, 54 insertions, 0 deletions
diff --git a/src/ceph/doc/api/index.rst b/src/ceph/doc/api/index.rst new file mode 100644 index 0000000..67d774c --- /dev/null +++ b/src/ceph/doc/api/index.rst @@ -0,0 +1,45 @@ +=================== + API Documentation +=================== + + +Ceph Storage Cluster APIs +========================= + +See `Ceph Storage Cluster APIs`_. + +.. _Ceph Storage Cluster APIs: ../rados/api/ + + +Ceph Filesystem APIs +==================== + +See `libcephfs (javadoc)`_. + +.. _libcephfs (javadoc): libcephfs-java + + +Ceph Block Device APIs +====================== + +See `librbdpy`_. + +.. _librbdpy: ../rbd/librbdpy + +Ceph RADOS Gateway APIs +======================= + +See `librgw-py`_. + +.. _librgw-py: ../radosgw/api + +Ceph Object Store APIs +====================== + +- See `S3-compatible API`_. +- See `Swift-compatible API`_. +- See `Admin Ops API`_. + +.. _S3-compatible API: ../radosgw/s3/ +.. _Swift-compatible API: ../radosgw/swift/ +.. _Admin Ops API: ../radosgw/adminops diff --git a/src/ceph/doc/api/libcephfs-java.rst b/src/ceph/doc/api/libcephfs-java.rst new file mode 100644 index 0000000..85b5c31 --- /dev/null +++ b/src/ceph/doc/api/libcephfs-java.rst @@ -0,0 +1,9 @@ +=================== +Libcephfs (JavaDoc) +=================== + +.. + The admin/build-docs script runs Ant to build the JavaDoc files, and + copies them to api/libcephfs-java/javadoc/. + +View the auto-generated `JavaDoc pages for the CephFS Java bindings <javadoc/>`_. |