Skip to content
Sphinx Theme based on bulma.io
CSS HTML Python Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
sphinx_bulma_theme
tests
.flake8
.gitignore
.release
.travis.yml
MANIFEST.in
Makefile
Pipfile
README.rst
package.json
requirements.txt
setup.cfg
setup.py
webpack.config.js

README.rst

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

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
You can’t perform that action at this time.