From: Kefu Chai <kchai@redhat.com>
Date: Thu, 12 Mar 2020 10:14:31 +0000 (+0800)
Subject: doc/cephfs: add python binding doc
X-Git-Tag: v16.1.0~2823^2~1
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=7357fde0701d64a07e31f5842fba30072b457bbc;p=ceph.git

doc/cephfs: add python binding doc

and restructure cephfs/api to move the javadoc for cephfs to this
directory

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

diff --git a/admin/build-doc b/admin/build-doc
index 289a2a688711..23e92e7efcc1 100755
--- a/admin/build-doc
+++ b/admin/build-doc
@@ -157,7 +157,7 @@ rm -rf $JAVADIR/doc
 ant -buildfile $JAVADIR/build.xml docs
 
 # Create clean target directory
-JAVA_OUTDIR=$TOPDIR/build-doc/output/html/api/libcephfs-java/javadoc
+JAVA_OUTDIR=$TOPDIR/build-doc/output/html/cephfs/api/libcephfs-java/javadoc
 rm -rf $JAVA_OUTDIR
 mkdir $JAVA_OUTDIR
 
diff --git a/doc/api/index.rst b/doc/api/index.rst
index afeefc50befd..9b9283139fa4 100644
--- a/doc/api/index.rst
+++ b/doc/api/index.rst
@@ -14,10 +14,9 @@ See `Ceph Storage Cluster APIs`_.
 Ceph File System APIs
 =====================
 
-See `libcephfs (javadoc)`_.
-
-.. _libcephfs (javadoc): libcephfs-java
+See `libcephfs`_
 
+.. _libcephfs: ../cephfs/api
 
 Ceph Block Device APIs
 ======================
diff --git a/doc/api/libcephfs-java.rst b/doc/api/libcephfs-java.rst
deleted file mode 100644
index 83b5a6638801..000000000000
--- a/doc/api/libcephfs-java.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-===================
-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/index.rst b/doc/cephfs/api/index.rst
new file mode 100644
index 000000000000..2247610bb6d8
--- /dev/null
+++ b/doc/cephfs/api/index.rst
@@ -0,0 +1,9 @@
+============
+ 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 000000000000..83b5a6638801
--- /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 000000000000..039401f22272
--- /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
diff --git a/doc/cephfs/index.rst b/doc/cephfs/index.rst
index 4031e1032031..1a304f899f30 100644
--- a/doc/cephfs/index.rst
+++ b/doc/cephfs/index.rst
@@ -184,7 +184,7 @@ Developer Guides
 
     Journaler Configuration <journaler>
     Client's Capabilities <capabilities>
-    libcephfs for Java <../../api/libcephfs-java/>
+    Java and Python bindings <api/index>
     Mantle <mantle>