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 f2559fe98 chore(bindings/python): improve ASF branding (#3850)
f2559fe98 is described below
commit f2559fe98bbc1d65995bfa67167d9fc7323c44a5
Author: tison <[email protected]>
AuthorDate: Fri Dec 29 11:49:43 2023 +0800
chore(bindings/python): improve ASF branding (#3850)
* chore(bindings/python): improve ASF branding
Signed-off-by: tison <[email protected]>
* ci: use the template
Signed-off-by: tison <[email protected]>
* license header
Signed-off-by: tison <[email protected]>
---------
Signed-off-by: tison <[email protected]>
---
.github/workflows/docs.yml | 2 +-
bindings/python/README.md | 2 +-
bindings/python/template/module.html.jinja2 | 34 +++++++++++++++++++++++++++++
3 files changed, 36 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 5eed7c48d..f9e0026b2 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -142,7 +142,7 @@ jobs:
- name: Build Docs
working-directory: bindings/python
- run: pdoc --output-dir ./docs opendal
+ run: pdoc -t ./template --output-dir ./docs opendal
- name: Upload docs
uses: actions/upload-artifact@v3
diff --git a/bindings/python/README.md b/bindings/python/README.md
index ee2c7751d..1a3b87f39 100644
--- a/bindings/python/README.md
+++ b/bindings/python/README.md
@@ -103,5 +103,5 @@ Build API docs:
```shell
maturin develop -E docs
-pdoc opendal
+pdoc -t ./template opendal
```
diff --git a/bindings/python/template/module.html.jinja2
b/bindings/python/template/module.html.jinja2
new file mode 100644
index 000000000..be6daa2cb
--- /dev/null
+++ b/bindings/python/template/module.html.jinja2
@@ -0,0 +1,34 @@
+{#
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+#}
+
+{% extends "default/module.html.jinja2" %}
+
+{% block nav_title %}
+<h1>Apache OpenDAL™</h1>
+{% endblock %}
+
+{% block module_contents %}
+{{ super() }}
+<footer>
+Copyright © 2022-<script>document.write(new Date().getFullYear())</script>,
+The Apache Software Foundation Apache OpenDAL, OpenDAL, Apache, Apache
Incubator, the Apache feather,
+the Apache Incubator logo and the Apache OpenDAL project logo are either
registered trademarks or
+trademarks of the Apache Software Foundation.
+</footer>
+{% endblock %}
