diff options
Diffstat (limited to 'doc/cephfs/api')
| -rw-r--r-- | doc/cephfs/api/index.rst | 11 | ||||
| -rw-r--r-- | doc/cephfs/api/libcephfs-java.rst | 18 | ||||
| -rw-r--r-- | doc/cephfs/api/libcephfs-py.rst | 13 |
3 files changed, 42 insertions, 0 deletions
diff --git a/doc/cephfs/api/index.rst b/doc/cephfs/api/index.rst new file mode 100644 index 000000000..bb6250200 --- /dev/null +++ b/doc/cephfs/api/index.rst @@ -0,0 +1,11 @@ +.. _cephfs api: + +============ + CephFS APIs +============ + +.. toctree:: + :maxdepth: 2 + + libcephfs (Java) <libcephfs-java> + libcephfs (Python) <libcephfs-py> diff --git a/doc/cephfs/api/libcephfs-java.rst b/doc/cephfs/api/libcephfs-java.rst new file mode 100644 index 000000000..83b5a6638 --- /dev/null +++ b/doc/cephfs/api/libcephfs-java.rst @@ -0,0 +1,18 @@ +=================== +Libcephfs (JavaDoc) +=================== + +.. warning:: + + CephFS Java bindings are no longer tested by CI. They may not work properly + or corrupt data. + + Developers interested in reviving these bindings by fixing and writing tests + are encouraged to contribute! + +.. + 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/>`_. diff --git a/doc/cephfs/api/libcephfs-py.rst b/doc/cephfs/api/libcephfs-py.rst new file mode 100644 index 000000000..039401f22 --- /dev/null +++ b/doc/cephfs/api/libcephfs-py.rst @@ -0,0 +1,13 @@ +=================== + LibCephFS (Python) +=================== + +.. highlight:: python + +The `cephfs` python module provides access to CephFS service. + +API calls +========= + +.. automodule:: cephfs + :members: DirEntry, DirResult, LibCephFS |