User Guide

This section serves to guide the user for using this theme.

Note

The theme and user guide is working in progress.

Get started

To use this theme in your documentation build environment, first install the bulma-sphinx-theme with pip:

pip install bulma-sphinx-theme

then, configure the Sphinx docs to use the theme by editing conf.py

html_theme = "bulma_sphinx_theme"

Your Sphinx documentation’s HTML pages will now be generated with this theme! 🎉

• Navbar configuration
  • Changing the navbar color style
  • Fix navbar
  • Disable navbar
  • Changing header icons
• Changing sidenav elements
  • Changing sidenav width
• Source Buttons
  • Add an edit button
  • View Source link

Last updated on May 29, 2023.

previous

Bulma Sphinx Theme

next

Navbar configuration