sphinx扩展将github功能区放置到每个html页面
sphinxcontrib-github_ribbon的Python项目详细描述
sphinxcontrollib-github_ribbon是一个sphinx扩展,用于将github ribbon放置到每个html页面。
用法
在conf.py中追加此扩展名:
extensions = ['sphinxcontrib.github_ribbon']
并更新设置:
- github_ribbon_repo
- 存储库的位置。默认情况下,“sphinx doc/sphinx”
- github_ribbon_position=(“左”“右”)
- 色带的位置。默认情况下,“right”
- github_ribbon_color=(“红色”“绿色”“深蓝色”“橙色”“灰色”“白色”)
- 色带的颜色。默认情况下,“red”
特别感谢
sphinx-users.jp的成员!