sphinx-bulma 0.0.12

A Sphinx theme using Bulma

Currently updating major changes and updates from AccentDesign/karma_sphinx_theme

Check todo list for planned features to be included on release version v0.1.0 (cur: v0.0.12)

A simple responsive theme for sphinx using Bulma featuring:

1. Has built-in dark/light color themes using native CSS and JavaScript
2. Sphinx built-in text search engine
3. Extended Sass rulesets from bulma
4. Support for user-defined favicon and logo from sphinx config
5. Custom icon font made with Fontello
6. Theme user-defined documentation repository reference

Yet to be done a.k.a todo

• Support user-defined colors (primary color can be changed from conf.py)
• Enable custom Sass rules on docs build (can be done but requires user to build theme again)
• Examples of use with breathe for C++ docs

Installing

Using pip to install this package (recommended using it within a venv):

pip install sphinx-bulma

Configuration

The theme's project-wide options are defined in the src/sphinx-bulma/theme.conf file, and can be defined in your project's conf.py via html_theme_options. For example:

html_theme_options = {
  'navigation_depth': 2,           # maximum depth of tree
  'includehidden': True,           # if true sidebar may include toctrees marked with hidden option
  'titles_only': False,            # if true removes headers within a page from the sidebar
  'display_git': False,            # if true options below must be set
  'git_host': 'github.com',        # git host url
  'git_user': 'gh-user',           # your git host username
  'git_repo': 'doc-repo',          # doc repository
  'git_blob': 'blob',              # default for github
  'git_version': 'master/docs/',   # docs folder
  'git_icon': 'github',            # icon to show on docs
  'git_desc': 'Check the sources', # link description
  'default_palette': 'dark',       # default color palette (dark or light)
  'sidebar': True,                 # if true sidebar will be rendered
  'primary': 885bfb,               # primary color hex value (do not add preceding #)
  'primary_invert': fff            # primary inverted color hex value (do not add preceding #)
}