sphinx_holoviz_theme: 构建HoloViz站点的主题

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

这是什么？

sphinx_holoviz_theme 是在 HoloViz 生态系统构建站点时使用的主题。此主题最好与 nbsite 结合使用。请参阅 nbsite 文档 以获取示例。

如何使用

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

html_static_path += ['_static']
html_theme = 'sphinx_holoviz_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 扩展/覆盖。

注意： 只使用 custom_css 覆盖 css 的小部分，而不是进行一般改进。如果您有一般改进，请在该存储库上打开一个 PR。

关于 HoloViz

sphinx_holoviz_theme 是 HoloViz 生态系统的一部分，用于简化 Python 中的可视化高级工具。请参阅 holoviz.org 了解您可以与 sphinx_holoviz_theme 一起使用的相关包，以及 status.pyviz.org 了解每个 HoloViz 项目的当前状态。