From dbe0dc0819ec7ca847235ba19a019aeb37c93eff Mon Sep 17 00:00:00 2001 From: chitralverma Date: Tue, 7 Jul 2026 18:12:43 +0530 Subject: [PATCH 1/2] docs(python): fix duplicated headings on layers and types API pages The layers and types API pages put a manual Markdown heading before each mkdocstrings block, while mkdocstrings also renders its own heading for the class. That produced two headings (and two table-of-contents entries) per class. Drop the redundant manual headings so each class renders once, matching the single-class API pages. --- bindings/python/docs/api/layers.md | 4 ---- bindings/python/docs/api/types.md | 4 ---- 2 files changed, 8 deletions(-) diff --git a/bindings/python/docs/api/layers.md b/bindings/python/docs/api/layers.md index 9d89e75ffb97..054e7d497cd4 100644 --- a/bindings/python/docs/api/layers.md +++ b/bindings/python/docs/api/layers.md @@ -2,7 +2,6 @@ This page documents all layers in OpenDAL. -## Layer ::: opendal.layers.Layer options: heading: "opendal.layers.Layer" @@ -10,21 +9,18 @@ This page documents all layers in OpenDAL. show_source: false show_bases: false -## RetryLayer ::: opendal.layers.RetryLayer options: heading: "opendal.layers.RetryLayer" heading_level: 2 show_source: false -## ConcurrentLimitLayer ::: opendal.layers.ConcurrentLimitLayer options: heading: "opendal.layers.ConcurrentLimitLayer" heading_level: 2 show_source: false -## MimeGuessLayer ::: opendal.layers.MimeGuessLayer options: heading: "opendal.layers.MimeGuessLayer" diff --git a/bindings/python/docs/api/types.md b/bindings/python/docs/api/types.md index 736a088c4eb7..1227dc1fe4eb 100644 --- a/bindings/python/docs/api/types.md +++ b/bindings/python/docs/api/types.md @@ -2,7 +2,6 @@ This page documents all types in OpenDAL. -## Entry ::: opendal.types.Entry options: heading: "opendal.types.Entry" @@ -10,13 +9,11 @@ This page documents all types in OpenDAL. show_source: false show_bases: false -## EntryMode ::: opendal.types.EntryMode options: heading: "opendal.types.EntryMode" heading_level: 2 -## Metadata ::: opendal.types.Metadata options: heading: "opendal.types.Metadata" @@ -24,7 +21,6 @@ This page documents all types in OpenDAL. show_source: false show_bases: false -## PresignedRequest ::: opendal.types.PresignedRequest options: heading: "opendal.types.PresignedRequest" From 5b6dc364f7949f5fb12d03daf6e79e8d92536743 Mon Sep 17 00:00:00 2001 From: chitralverma Date: Tue, 7 Jul 2026 20:04:12 +0530 Subject: [PATCH 2/2] Fix typo in Python binding documentation --- bindings/python/docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bindings/python/docs/index.md b/bindings/python/docs/index.md index 8717fa722850..64106e54d0d1 100644 --- a/bindings/python/docs/index.md +++ b/bindings/python/docs/index.md @@ -9,7 +9,7 @@ pip install opendal ## Local Usage Developer must set two required arguments to work with files locally: - `scheme`: which should be specified as `fs` -- `root`: where OpenDAl considers the root of the directory for operations will be. +- `root`: where OpenDAL considers the root of the directory for operations will be. For example in the following operator: `opendal.Operator("fs", root="/foo")`