sphinx-bulma-theme

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

Demo

https://readthedocs.org/projects/sphinx-bulma-theme/badge/?version=latest

https://travis-ci.org/gabrielfalcao/sphinx-bulma-theme.svg?branch=master

https://img.shields.io/pypi/pyversions/sphinx-bulma-theme.svg

https://badges.gitter.im/gabrielfalcao/sphinx-bulma-theme.svg

https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_bulma_theme-0.2.9.tar.gz (2.6 MB view details)

Uploaded Apr 30, 2018 Source

File details

Details for the file sphinx_bulma_theme-0.2.9.tar.gz.

File metadata

Download URL: sphinx_bulma_theme-0.2.9.tar.gz
Upload date: Apr 30, 2018
Size: 2.6 MB
Tags: Source
Uploaded using Trusted Publishing? No

File hashes

Hashes for sphinx_bulma_theme-0.2.9.tar.gz
Algorithm	Hash digest
SHA256	`3ee7fe85bc587cb365a67550843d4b5e3a3802e154e402e0d67660fff9b08e7e`
MD5	`bb6d7901f3c5b4ebd8438040d6538340`
BLAKE2b-256	`b87e9396b52b891ea3bce0cd018f7fbeeda0aad22a98399953dd272eb2bc4156`