Theme for building pyviz sites; best when used with nbsite.
Project description
sphinx_pyviz_theme: Theme for building pyviz sites
Build Status | |
Latest dev release | |
Latest release |
What is it?
sphinx_pyviz_theme is the theme that is used when building sites in the pyviz ecosystem. This theme is best used in conjunction with nbsite. See the nbsite docs for examples.
How to use
To use this theme: pip/conda install sphinx_pyviz_theme
and set html_theme to sphinx_pyviz_theme. To control the look and feel, change html_theme_options in conf.py:
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 and favicon: provide paths relative to html_static_path (doc/_static by default)
- primary_color, primary_color_dark and secondary_color: control the colors that the website uses for header, nav, links... These can be css named colors, or hex colors.
- second_nav: Boolean indicating whether to use a second nav bar.
- custom_css: path relative to html_static_path overriding styles. Styles come first from the theme's main.css_t, which is populated with the colors options, then extended/overridden by your site's own css.
NOTE: Only use the custom_css to overwrite small pieces of the css not to make general improvements. If you have general improvements, please open a PR on the this repo.
About PyViz
sphinx_pyviz_theme is part of the PyViz initiative for making Python-based visualization tools work well together. See pyviz.org for related packages that you can use with sphinx_pyviz_theme and status.pyviz.org for the current status of each PyViz project.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_pyviz_theme-0.0.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a891ffaec96cfe8760223b9af8703cdcbe6142fe2ed52b0b267647383052f7fa |
|
MD5 | 0d15e8434fc6ef756926eb58119b9981 |
|
BLAKE2b-256 | 1428af09f24d6f989c6be654480a897bfdc8ae39de45dce6a5444dbfb2fbbf3a |