跳转到主要内容

Sphinx扩展,用于在每个HTML页面添加GitHub徽章

项目描述

github_ribbon_sphinx 是一个Sphinx扩展,用于在每个HTML页面添加 GitHub徽章

使用方法

在 conf.py 中添加此扩展

extensions = ['sphinxcontrib.github_ribbon']

并更新设置

github_ribbon_repo

您的仓库位置。默认为 “sphinx-doc/sphinx”

github_ribbon_position = (“left” | “right”)

徽章的位置。默认为 “right”

github_ribbon_color = (“red” | “green” | “darkblue” | “orange” | “gray” | “white”)

徽章的颜色。默认为 “red”

特别感谢

Sphinx-users.jp的成员!

项目详情


下载文件

下载适合您平台文件。如果您不确定要选择哪个,请了解更多关于 安装包 的信息。

源代码发行版

sphinxcontrib-github_ribbon-0.9.0.tar.gz (3.2 kB 查看哈希值)

上传时间: 源代码

构建发行版

sphinxcontrib_github_ribbon-0.9.0-py2.py3-none-any.whl (5.3 kB 查看哈希值)

上传时间 Python 2 Python 3

由以下支持