User Guide

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

Note

The theme and user guide is working in progress.

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
  • Add Mega Menus to navbar
• Changing sidenav elements
  • Changing sidenav width
  • Changing sidenav background
• Source Buttons
  • Add an edit button
  • View Source link
• Search button
  • Configure the search bar text
• Adding custom CSS Stylesheets
• Changing Fonts
• Changing landing page
• Theme-specific elements
  • Mathematics
  • Code blocks
  • Inline code
  • Admonition sidebars
  • Footnotes
  • Version changes
  • Link shortening for git repository services
• Sphinx Design Components
  • Badges and buttons
  • Cards
  • Tabs
  • Dropdowns
  • Copybuttons
  • Toggle buttons
• Using bulma extensions
• Blogs with ABlog
  • Example blog
  • Example post list
• Develop this theme
  • Overview
  • Theme structure
  • Initial Setup
  • Build the theme

Last updated on Jan 16, 2024.

previous

Bulma Sphinx Theme

next

Navbar configuration