sphinx_pyviz_theme: 构建pyviz站点的主题

构建状态
最新开发版本
最新版本

这是什么？

sphinx_pyviz_theme 是用于构建 pyviz 生态系统中站点的主题。此主题最好与 nbsite 一起使用。有关示例，请参阅 nbsite 文档。

如何使用

要使用此主题： pip/conda install sphinx_pyviz_theme 并将 html_theme 设置为 sphinx_pyviz_theme。要控制外观和感觉，请更改 conf.py 中的 html_theme_options。

html_static_path += ['_static']
html_theme = 'sphinx_pyviz_theme'
html_theme_options = {
    'custom_css': 'site.css',
    'logo': 'nbsite-logo.png',
    'favicon': 'favicon.ico',
    'primary_color': '#F16A25',
    'primary_color_dark': '#B5501C',
    'secondary_color': '#F5C33C',
    'second_nav': False,
}

• logo 和 favicon：提供相对于 html_static_path 的路径（默认为 doc/_static）
• primary_color, primary_color_dark 和 secondary_color：控制网站用于标题、导航、链接等处的颜色。这些可以是 CSS 命名颜色或十六进制颜色。
• second_nav：布尔值，表示是否使用第二个导航栏。
• custom_css：相对于 html_static_path 的路径，用于覆盖样式。样式首先来自主题的 main.css_t，其中包含颜色选项，然后由您网站的自身 CSS 扩展/覆盖。

关于 PyViz

sphinx_pyviz_theme 是 PyViz 创新的一部分，旨在使基于 Python 的可视化工具能够很好地协同工作。有关与 sphinx_pyviz_theme 一起使用的相关包，请参阅 pyviz.org，有关每个 PyViz 项目的当前状态，请参阅 status.pyviz.org。