(opendal) branch main updated: doc: fix python binding doc which changed (#6008)

[me...@apache.org]

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

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


The following commit(s) were added to refs/heads/main by this push:
     new 13f2b8a38 doc: fix python binding doc which changed (#6008)
13f2b8a38 is described below

commit 13f2b8a3802ac84b2ac7dd12a88dcb7191d309a0
Author: yihong <zo...@gmail.com>
AuthorDate: Sat Apr 12 10:54:21 2025 +0800

    doc: fix python binding doc which changed (#6008)
    
    Signed-off-by: yihong0618 <zo...@gmail.com>
---
 bindings/python/README.md  | 11 ++++++-----
 bindings/python/upgrade.md |  3 +--
 2 files changed, 7 insertions(+), 7 deletions(-)

diff --git a/bindings/python/README.md b/bindings/python/README.md
index b90023b1b..d1f1383a8 100644
--- a/bindings/python/README.md
+++ b/bindings/python/README.md
@@ -1,12 +1,12 @@
 # Apache OpenDAL™ Python Binding
 
-[![](https://img.shields.io/badge/status-released-blue)](https://pypi.org/project/opendal/)
+[![img](https://img.shields.io/badge/status-released-blue)](https://pypi.org/project/opendal/)
 [![PyPI](https://img.shields.io/pypi/v/opendal.svg?logo=PyPI)](https://pypi.org/project/opendal/)
 [![Website](https://img.shields.io/badge/opendal-OpenDAL_Website-red?logo=Apache&logoColor=red)](https://opendal.apache.org/docs/python/)
 
 This package intends to build a native python binding for Apache OpenDAL.
 
-![](https://github.com/apache/opendal/assets/5351546/87bbf6e5-f19e-449a-b368-3e283016c887)
+![img](https://github.com/apache/opendal/assets/5351546/87bbf6e5-f19e-449a-b368-3e283016c887)
 
 ## Useful Links
 
@@ -23,6 +23,7 @@ pip install opendal
 ## Usage
 
 fs service example:
+
 ```python
 import opendal
 
@@ -46,6 +47,7 @@ asyncio.run(main())
 ```
 
 s3 service example:
+
 ```python
 import opendal
 
@@ -68,13 +70,12 @@ async def main():
 asyncio.run(main())
 ```
 
-
 ## Development
 
 Setup virtualenv:
 
 ```shell
-uv venv --python 3.10
+uv venv --python 3.11
 ```
 
 Install all the dependencies:
@@ -93,7 +94,7 @@ OPENDAL_TEST=fs OPENDAL_FS_ROOT=/tmp uv run pytest -vk test_write
 Build API docs:
 
 ```shell
-uv run pdoc -t ./template opendal
+uv run mkdocs build
 ```
 
 ## Used by
diff --git a/bindings/python/upgrade.md b/bindings/python/upgrade.md
index 51d4ce2c6..4582b1769 100644
--- a/bindings/python/upgrade.md
+++ b/bindings/python/upgrade.md
@@ -4,8 +4,7 @@
 
 Because of [a TLS lib issue](https://github.com/apache/opendal/issues/3650), we temporarily disable the `services-ftp` feature.
 
-
-# Upgrade to v0.42
+## Upgrade to v0.42
 
 ## Breaking change for layers