Skip to content

Commit

Permalink
wakepy logos and banners (Part 2) (#371)
Browse files Browse the repository at this point in the history
Closes: #287

Update the logo with darker background. Make the logo more suitable for
dark (& light) theme. Add logo to docs. Create separate images:
* small logo (docs upper left corner)
* banner (start of README & docs)
* social share image (just for GitHub share)
  • Loading branch information
fohrloop authored Jun 24, 2024
1 parent 3481031 commit 19bad39
Show file tree
Hide file tree
Showing 7 changed files with 525 additions and 52 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/fohrloop/wakepy) ![PyPI](https://img.shields.io/pypi/v/wakepy) ![PyPI - Downloads](https://img.shields.io/pypi/dm/wakepy) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) ![mypy](https://img.shields.io/badge/mypy-checked-blue) ![mypy](https://img.shields.io/badge/code_style-black-black) ![coverage](https://img.shields.io/badge/coverage-100%25-32bb13)
[![pyversions](https://img.shields.io/pypi/pyversions/wakepy.svg)](https://pypi.python.org/pypi/wakepy) ![License](https://img.shields.io/github/license/fohrloop/wakepy)

![](./docs/source/img/wakepy-logo.svg)
![](./docs/source/img/wakepy-banner.svg)

Cross-platform wakelock / keep-awake / stay-awake written in Python.

Expand Down Expand Up @@ -234,6 +234,10 @@ Wakepy vision is to support *any*<sup>†</sup> environment which runs Python. T

In addition, [supporting PyPy](https://github.com/fohrloop/wakepy/issues/274) is on the roadmap. If you have ideas or comments, please post yours on [wakepy/#317](https://github.com/fohrloop/wakepy/discussions/317).

## Licenses

The contents of this repository are licensed with [MIT License](https://github.com/fohrloop/wakepy/blob/main/LICENSE.txt), which is permissive and allows you to use the code as part of any application or library, commercial or not, with the following exception: The GitHub Invertocat logo used in the social share image is property of GitHub, downloaded from [github.com/logos](https://github.com/logos) and is used under the terms specified by GitHub.

---------------

## Footnotes
Expand Down
9 changes: 9 additions & 0 deletions docs/source/_static/wakepy-docs.css
Original file line number Diff line number Diff line change
Expand Up @@ -147,3 +147,12 @@ thead > tr {
background-color: var(--wakepy-table-color-header-bg) !important;
border-bottom: 1px solid var(--wakepy-table-color-header-bottom-border) !important;
}

.logo {
margin-top: -10px !important;
margin-bottom: -5px !important;
}

html[data-theme=dark] .bd-content img:not(.only-dark,.dark-light) {
background-color: var(--wakepy-color-contents-bg) !important;
}
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@

html_static_path = ["_static"]
html_css_files = ["wakepy-docs.css"]
html_logo = "img/logo-small.svg"

# -- Options for HTML output -------------------------------------------------

Expand Down
122 changes: 71 additions & 51 deletions docs/source/img/wakepy-logo.svg → docs/source/img/logo-small.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
212 changes: 212 additions & 0 deletions docs/source/img/wakepy-banner.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
225 changes: 225 additions & 0 deletions docs/source/img/wakepy-github-social-share.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
![](./img/wakepy-banner.svg)
<br><br><br>
# Overview

```{include} ../../README.md
Expand Down

0 comments on commit 19bad39

Please sign in to comment.