一个干净可定制的Sphinx文档主题。
项目描述
Furo
A clean customisable Sphinx documentation theme.
简介
- 故意简约 --- 最重要的东西是内容，而不是围绕它的结构。
- 响应式 --- 完美适应可用屏幕空间，可在各种设备上使用。
- 可定制 --- 可以更改调色板、字体族、徽标等！
- 易于导航 --- 通过精心设计的侧边栏导航和页面间链接。
- 美观的内容 --- 通过清晰的排版和良好的样式元素。
- 美观的搜索 --- 帮助读者快速找到他们想要的内容。
- 偏向小型文档集 --- 适用于小型文档集，其中在侧边栏中显示整个层次结构不会令人感到压倒。
快速入门
Furo在PyPI上分发。要在您的Sphinx项目中使用此主题
-
在文档构建环境中安装Furo。
pip install furo
-
更新conf.py中的html_theme。
html_theme = "furo"
-
您的Sphinx文档的HTML页面现在将使用此主题生成！🎉
有关更多信息，请访问Furo的文档。
贡献
福鲁是一个由志愿者维护的开源项目，我们欢迎所有形式的贡献。请查看我们的贡献指南获取更多信息。
致谢
福鲁受到了一些优秀技术文档主题的启发（并借鉴了其中的元素）
- mkdocs-material，用于MkDocs
- Just the Docs，用于Jekyll
- GitBook
- pdoc3
我们使用BrowserStack在真实设备和浏览器上进行测试。感谢他们支持开源项目！
这个名字的由来是什么？
我从家猫的科学名称中汲取了灵感：Mustela putorius furo。
家猫实际上是这个项目的吉祥物：可爱、小巧，能从各个地方偷些小东西，当你试图让它做它不喜欢的事情时，它会对你发出嘶嘶声。
我计划为这个项目委托一个标志（或者自己制作一个），标志将是一个可爱的小猫。如果你对此感兴趣，请与我联系！
使用情况
我被告知，提及谁使用
$thing是推广$thing的好方法。
- urllib3 -- 福鲁的第一批用户
- attrs -- 早期用户之一！
- pip -- 我为此编写了它
- Python开发者指南
- black
许可证
本项目采用MIT许可协议。
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。
源代码分发
furo-2024.8.6.tar.gz (1.7 MB 查看哈希值)
构建分发
furo-2024.8.6-py3-none-any.whl (341.3 kB 查看哈希值)
关闭
furo-2024.8.6.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | b63e4cee8abfc3136d3bc03a3d45a76a850bada4d6374d24c1716b0e01394a01 |
|
| MD5 | f3097240959189473d67d001bb2ddd71 |
|
| BLAKE2b-256 | a0e2d351d69a9a9e4badb4a5be062c2d0e87bd9e6c23b5e57337fef14bef34c8 |
关闭
furo-2024.8.6-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 6cd97c58b47813d3619e63e9081169880fbe331f0ca883c871ff1f3f11814f5c |
|
| MD5 | 23c9705fc01d1ec45e00c7b1c2c7c255 |
|
| BLAKE2b-256 | 2748e791a7ed487dbb9729ef32bb5d1af16693d8925f4366befef54119b2e576 |
