diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5eed7c48da1..f9e0026b238 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 ee2c7751d53..1a3b87f3903 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 00000000000..be6daa2cb0c --- /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 %} +

Apache OpenDAL™

+{% endblock %} + +{% block module_contents %} +{{ super() }} + +{% endblock %}