[incubator-opendal] branch main updated: docs(bindings/python): add pdoc to docs env (#1718)

[xu...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git


The following commit(s) were added to refs/heads/main by this push:
     new 65bea6f8 docs(bindings/python): add pdoc to docs env (#1718)
65bea6f8 is described below

commit 65bea6f869a7d1ad9a2750726af098e06c16f8eb
Author: Chojan Shang <ps...@apache.org>
AuthorDate: Tue Mar 21 23:08:36 2023 +0800

    docs(bindings/python): add pdoc to docs env (#1718)
    
    Signed-off-by: Chojan Shang <ps...@outlook.com>
---
 bindings/python/README.md      | 9 ++++++++-
 bindings/python/pyproject.toml | 1 +
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/bindings/python/README.md b/bindings/python/README.md
index 03a4bcb1..7ca69d2a 100644
--- a/bindings/python/README.md
+++ b/bindings/python/README.md
@@ -58,9 +58,16 @@ Build bindings:
 maturin develop
 ```
 
-Running some tests:
+Run some tests:
 
 ```shell
 maturin develop -E test
 behave tests
 ```
+
+Build API docs:
+
+```shell
+maturin develop -E docs
+pdoc opendal
+```
\ No newline at end of file
diff --git a/bindings/python/pyproject.toml b/bindings/python/pyproject.toml
index 1eacb736..4b300767 100644
--- a/bindings/python/pyproject.toml
+++ b/bindings/python/pyproject.toml
@@ -33,6 +33,7 @@ requires-python = ">=3.7"
 
 [project.optional-dependencies]
 test = ["behave"]
+docs = ["pdoc"]
 
 [project.urls]
 Documentation = "https://docs.rs/opendal/"