Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(bindings/python): improve ASF branding #3850

Merged
merged 3 commits into from
Dec 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion bindings/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,5 +103,5 @@ Build API docs:

```shell
maturin develop -E docs
pdoc opendal
pdoc -t ./template opendal
```
34 changes: 34 additions & 0 deletions bindings/python/template/module.html.jinja2
Original file line number Diff line number Diff line change
@@ -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" %}
tisonkun marked this conversation as resolved.
Show resolved Hide resolved

{% 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 %}