Skip to content

Commit bd26812

Browse files
[SymForce] New Images
Fix the favicon, new banner image Not sure how I feel about the dark mode one and whether it's too busy / hard to read, and if I should just go back to the white box or fill in more or something Topic: sym-images Reviewers: hayk,bradley GitOrigin-RevId: 50d96fc1a10087dccd05e5cfce9c2df076116e1e
1 parent 9f1345b commit bd26812

15 files changed

+23
-11
lines changed

.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33

44
# Do not use git-fat for images in SymForce, to be copybara
55
# compatible and to show them from the README on Github.
6+
*.ico filter=
67
*.png filter=
78
*.jpg filter=
89
*.gif filter=

Makefile

+2
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,8 @@ PY_EXTENSION_MODULE_PATH?=$(BUILD_DIR)/pybind
177177
docs_html: docs_apidoc
178178
export PYTHONPATH=$(PY_EXTENSION_MODULE_PATH):$(PYTHONPATH); \
179179
SYMFORCE_LOGLEVEL=WARNING $(PYTHON) -m sphinx -b html docs $(DOCS_DIR) -j $$(nproc)
180+
mkdir $(DOCS_DIR)/docs
181+
ln -s ../_static $(DOCS_DIR)/docs/static
180182

181183
docs: docs_clean docs_html
182184

README.md

+13-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
1-
<a href="http://symforce.org" target="_blank">
2-
<img alt="SymForce" src="https://symforce-6d87c842-22de-4727-863b-e556dcc9093b.vercel.app/images/symforce_horizontal_white.png" width="600px"/>
3-
</a>
4-
5-
[![Documentation](https://img.shields.io/badge/api-docs-blue)](https://symforce.org)
6-
[![Source Code](https://img.shields.io/badge/source-code-blue)](https://github.com/symforce-org/symforce)
7-
[![Issues](https://img.shields.io/badge/issue-tracker-blue)](https://github.com/symforce-org/symforce/issues)
8-
![Python 3.8](https://img.shields.io/badge/python-3.8-blue)
9-
![C++ 14](https://img.shields.io/badge/c++-14-blue)
1+
<!-- There's no good way to make an image that's different on light/dark mode that also links
2+
somewhere. The closest thing is to add a #gh-light-mode-only to the target, which does this,
3+
but is kinda confusing -->
4+
![SymForce](docs/static/symforce_banner.png#gh-light-mode-only)
5+
![SymForce](docs/static/symforce_banner_dark.png#gh-dark-mode-only)
6+
7+
<p align="center">
8+
<a href="https://symforce.org"><img alt="Documentation" src="https://img.shields.io/badge/api-docs-blue" /></a>
9+
<a href="https://github.com/symforce-org/symforce"><img alt="Source Code" src="https://img.shields.io/badge/source-code-blue" /></a>
10+
<a href="https://github.com/symforce-org/symforce/issues"><img alt="Issues" src="https://img.shields.io/badge/issue-tracker-blue" /></a>
11+
<img alt="Python 3.8" src="https://img.shields.io/badge/python-3.8-blue" />
12+
<img alt="C++14" src="https://img.shields.io/badge/c++-14-blue" />
13+
</p>
1014

1115
---
1216

docs/conf.py

+3-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,9 @@
142142
# so a file named "default.css" will overwrite the builtin "default.css".
143143
html_static_path = ["static"]
144144

145-
html_favicon = "static/favicon.png"
145+
html_css_files = ["css/custom.css"]
146+
147+
html_favicon = "static/favicon.ico"
146148

147149
# Custom sidebar templates, must be a dictionary that maps document names
148150
# to template names.
16.1 KB
Loading
59 KB
Loading

docs/static/apple-touch-icon.png

14.6 KB
Loading

docs/static/css/custom.css

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[href$="#gh-dark-mode-only"], [src$="#gh-dark-mode-only"] {
2+
display: none;
3+
}

docs/static/favicon-16x16.png

630 Bytes
Loading

docs/static/favicon-32x32.png

1.36 KB
Loading

docs/static/favicon.ico

15 KB
Binary file not shown.

docs/static/favicon.png

-1
This file was deleted.

docs/static/site.webmanifest

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}

docs/static/symforce_banner.png

19.2 KB
Loading

docs/static/symforce_banner_dark.png

22.2 KB
Loading

0 commit comments

Comments
 (0)