This is an automated email from the ASF dual-hosted git repository.
chitralverma 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 742ce3d80 docs(python): fix duplicated headings on layers and types
API pages (#7880)
742ce3d80 is described below
commit 742ce3d8068b9766c573c30f2d6dc7ffe75de13c
Author: Chitral Verma <[email protected]>
AuthorDate: Tue Jul 7 20:32:10 2026 +0530
docs(python): fix duplicated headings on layers and types API pages (#7880)
* 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.
* Fix typo in Python binding documentation
---
bindings/python/docs/api/layers.md | 4 ----
bindings/python/docs/api/types.md | 4 ----
bindings/python/docs/index.md | 2 +-
3 files changed, 1 insertion(+), 9 deletions(-)
diff --git a/bindings/python/docs/api/layers.md
b/bindings/python/docs/api/layers.md
index 9d89e75ff..054e7d497 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 736a088c4..1227dc1fe 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"
diff --git a/bindings/python/docs/index.md b/bindings/python/docs/index.md
index 8717fa722..64106e54d 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")`
