sphinx-bulma-theme 0.2.1

0.2.1

A Sphinx theme based on the RTD theme, built on top of bulma.io.

Demo

Motivation

Bulma has excellent content markup and great message boxes for admonitions

WORK IN PROGRESS

Installing

pip install sphinx-bulma-theme

Configuring

import sphinx_bulma_theme

html_theme = "bulma"
html_theme_path = [sphinx_bulma_theme.get_html_theme_path()]
html_theme_options = {
    'logo_path': 'logo.png',  # within _static/
    'admonition_class': 'is-small',
    'analytics_id': None,
    'breadcrumbs_at_top': False,
    'canonical_url': None,
    'collapse_navigation': False,
    'content_margin_left': None,
    'content_padding_left': None,
    'content_padding_top': None,
    'display_version': True,
    'logo_only': False,
    'navigation_depth': 4,
    'prev_next_buttons_location': 'bottom',
    'show_topbar': False,
    'sidebar_class': 'has-text-dark',
    'sidebar_container_class': 'is-one-quarter',
    'sidebar_right': None,
    'theme_sidebar_style': None,
    'topbar_class': 'is-light',
    'topbar_logo_class': 'image is-32x32',
}

Contributing

pipenv install --dev
make watch