基础工程的狮身人面像主题(基于烧瓶主题)

groundwork-sphinx-theme的Python项目详细描述


这个存储库包含sphinx样式,大多数与基础工作相关的项目都使用这些样式。 它是肯尼思·雷茨的主题在他的项目中的衍生,也是三浦彦的主题在烧瓶和烧瓶相关的项目中的衍生。 项目。要在Sphinx文档中使用此样式,请遵循以下指南:

  1. 使用pip:pip install groundwork-sphinx-theme

    安装包
  2. 将此添加到conf.py

    html_theme='groundwork'

配置

Groundwork Sphinx主题提供以下配置参数:

  • sidebar_width: Allows the user to set the sidebar width in pixels. Good for deeply nested TOCs (Default: 220x)
  • stickysidbar: If True it makes the sidebar always visible if pages get longer (Default: True)
  • stickysidbarscrollable: Makes the sticky sidebar scrollable in small browser windows (Default: False)
  • contribute: If True, a contribute-area with github-buttons is shown inside the sidebar
  • github_user: Used the for github follow button. E.g.: useblocks
  • github_fork: Used for the github fork buttons. E.g.: useblocks/groundwork

您可以在sphinx项目的文件conf.py中更改它们的值:

html_theme_options = {
    "sidebar_width": '240px',
    "stickysidebar": True,
    "stickysidebarscrollable": True,
    "contribute": True,
    "github_fork": "useblocks/groundwork",
    "github_user": "useblocks",
}

屏幕截图

screenshot of groundwork sphinx theme

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
用于切换状态结果的枚举的java输入   检测*NIX上打开的端口时出现java问题   java捕获和保存屏幕截图   java SLF4JLogback:基于日志级别的多模式   Java从字符串中删除动态子字符串   在spring引导中contextLoads测试时运行java Liquibase   基于规则集的任意嵌套POJO的java任意就地转换   java如何做,边做边循环这段代码?   java是什么导致jmh测量中的错误?   java Spring RabbitTemplate执行方法可见性   java jms创建连接http超时weblogic   java如何在JMapViewer中的两点之间放置像箭头一样的图像   在我的形状计算器Java程序中使用带有Switch/Case语句的循环   字符串如何在Java中比较字符和数字