You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by er...@apache.org on 2025/05/12 19:25:24 UTC

(opendal) 01/03: doc(bindings/python): use mkdocs-literate-nav TOC

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

erickguan pushed a commit to branch docs-service-website
in repository https://gitbox.apache.org/repos/asf/opendal.git

commit 1db99a766070d17e9e745817c56d5f982f5f10bf
Author: Erick Guan <29...@users.noreply.github.com>
AuthorDate: Sun May 11 17:45:31 2025 +0200

    doc(bindings/python): use mkdocs-literate-nav TOC
---
 bindings/python/docs/SUMMARY.md | 12 ++++++++++++
 bindings/python/mkdocs.yml      | 17 ++++-------------
 2 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/bindings/python/docs/SUMMARY.md b/bindings/python/docs/SUMMARY.md
new file mode 100644
index 000000000..dab52f1fc
--- /dev/null
+++ b/bindings/python/docs/SUMMARY.md
@@ -0,0 +1,12 @@
+- [Overview](index.md)
+- Examples
+    - [Basic](examples/basic.ipynb)
+    - [Pandas](examples/pandas.ipynb)
+    - [Polars](examples/polars.ipynb)
+- API Reference
+    - [Operator](api/operator.md)
+    - [File](api/file.md)
+    - [AsyncOperator](api/async_operator.md)
+    - [AsyncFile](api/async_file.md)
+    - [Metadata](api/metadata.md)
+- [Services](services/)
diff --git a/bindings/python/mkdocs.yml b/bindings/python/mkdocs.yml
index 13db72908..310ed6ad8 100644
--- a/bindings/python/mkdocs.yml
+++ b/bindings/python/mkdocs.yml
@@ -35,19 +35,10 @@ plugins:
           paths: [python]
           options:
             docstring_style: google
-
-nav:
-  - Overview: index.md
-  - Examples:
-      - Basic: examples/basic.ipynb
-      - Pandas: examples/pandas.ipynb
-      - Polars: examples/polars.ipynb
-  - API Reference:
-      - api/operator.md
-      - api/file.md
-      - api/async_operator.md
-      - api/async_file.md
-      - api/metadata.md
+  - literate-nav:
+      nav_file: SUMMARY.md
+      implicit_index: false
+      tab_length: 4
 
 markdown_extensions:
   - pymdownx.highlight: