Skip to content

Commit

Permalink
Point docs to Astral favicon (#13219)
Browse files Browse the repository at this point in the history
## Summary

Same as astral-sh/uv#6951. Unfortunately we have
to use a single favicon for the docs.
  • Loading branch information
charliermarsh authored Sep 3, 2024
1 parent c0e2c13 commit 6b973b2
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 5 deletions.
9 changes: 5 additions & 4 deletions .github/workflows/publish-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ jobs:
- name: "Set docs version"
run: |
version="${{ (inputs.plan != '' && fromJson(inputs.plan).announcement_tag) || inputs.ref }}"
# if version is missing, exit with error
if [[ -z "$version" ]]; then
echo "Can't build docs without a version."
exit 1
# if version is missing, use 'latest'
if [ -z "$version" ]; then
echo "Using 'latest' as version"
version="latest"
fi
# Use version as display name for now
Expand Down Expand Up @@ -145,6 +145,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.ASTRAL_DOCS_PAT }}
run: |
branch_name="${{ env.branch_name }}"
# auto-merge the PR if the build was triggered by a release. Manual builds should be reviewed by a human.
# give the PR a few seconds to be created before trying to auto-merge it
sleep 10
Expand Down
20 changes: 20 additions & 0 deletions docs/.overrides/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{% extends "base.html" %}

{% block extrahead %}
<link rel="apple-touch-icon" sizes="180x180" href="/static/apple-touch-icon.png"/>
<link rel="icon" type="image/png" sizes="32x32" href="/static/favicon-32x32.png"/>
<link rel="icon" type="image/png" sizes="16x16" href="/static/favicon-16x16.png"/>
<link rel="manifest" href="/static/site.webmanifest"/>
<link rel="mask-icon" href="/static/safari-pinned-tab.svg" color="#2e183d"/>
<meta name="msapplication-TileColor" content="#d7ff64"/>
<meta name="theme-color" content="#ffffff"/>
<meta name="robots" content="index,follow"/>
<script type="application/ld+json">
{
"@context": "https://schema.org",
"@type": "WebSite",
"name": "Astral",
"url": "https://astral.sh"
}
</script>
{% endblock %}
Binary file added docs/assets/favicon.ico
Binary file not shown.
2 changes: 1 addition & 1 deletion mkdocs.template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ site_name: Ruff
theme:
name: material
logo: assets/bolt.svg
favicon: assets/ruff-favicon.png
favicon: assets/favicon.ico
features:
- navigation.instant
- navigation.instant.prefetch
Expand Down

0 comments on commit 6b973b2

Please sign in to comment.