Sphinx扩展，支持自定义favicon
项目描述
Sphinx Favicon
注意：从版本0.2更新到版本1.0
在v0.2和v1.0之间，扩展的模块名称已更改为更好地符合Python标准。请将您的
conf.py中扩展列表中使用的名称从sphinx-favicon更新为sphinx_favicon！
Sphinx扩展，用于添加自定义favicon
使用Sphinx Favicon，您可以快速轻松地将自定义favicon添加到您的Sphinx html文档中。
您可以直接在您的 conf.py 中定义favicon，使用不同的 rel 属性，如 "icon" 或 "apple-touch-icon" 以及任何favicon大小。
Sphinx Favicon扩展比Sphinx支持的 标准 favicon.ico 提供了更大的灵活性。它提供了一种快速简单的方法来添加不同浏览器和设备的重要favicon格式。
安装
使用 pip 在您的环境中安装Sphinx Favicon
pip install sphinx-favicon
用法
安装 sphinx-favicon 后，将其添加到您的 conf.py 扩展列表中
extensions = ["sphinx_favicon"]
然后使用favicons参数配置favicon链接（如果使用相对路径，则必须指定html_static_path）
html_static_path = ["_static"]
favicons = [
{"href": "icon.svg"}, # => use `_static/icon.svg`
{"href": "https://secure.example.com/favicon/favicon-16x16.png"},
{"href": "https://secure.example.com/favicon/favicon-32x32.png"},
{
"rel": "apple-touch-icon",
"href": "https://secure.example.com/favicon/apple-touch-icon-180x180.png",
},
]
基于此配置，Sphinx将在HTML的<head>元素中包含以下favicon信息
<link rel="icon" href="_static/icon.svg" type="image/svg+xml">
<link rel="icon" href="https://secure.example.com/favicon/favicon-16x16.png" sizes="16x16" type="image/png">
<link rel="icon" href="https://secure.example.com/favicon/favicon-32x32.png" sizes="32x32" type="image/png">
<link rel="apple-touch-icon" href="https://secure.example.com/favicon/apple-touch-icon-180x180.png" sizes="180x180" type="image/png">
有关更多详细信息和高级用法，请参阅文档。
贡献
欢迎各种形式的贡献。有关更多信息，请参阅我们文档中的贡献部分。
关闭
sphinx-favicon-1.0.1.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | df796de32125609c1b4a8964db74270ebf4502089c27cd53f542354dc0b57e8e |
|
| MD5 | 211b14a52b5a6dfeaa1669af2825c27d |
|
| BLAKE2b-256 | b1253c78b785c3ea991597c310ac6bdc7949c2a7549e031dbb22db4ce8d1b99b |
关闭
sphinx_favicon-1.0.1-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 7c93d6b634cb4c9687ceab67a8526f05d3b02679df94e273e51a43282e6b034c |
|
| MD5 | 6f6833080660405d65ba390b687e4cf6 |
|
| BLAKE2b-256 | 92c2152bd6c211b847e525d2c7004fd98e3ac5baeace192716da8cd9c9ec2427 |
