Sphinx Bootstrap Theme.
Project description
This Sphinx theme integrates the Twitter Bootstrap CSS / JavaScript framework with various layout options, hierarchical menu navigation, and mobile-friendly responsive design.
Demos
Here is the theme in use for some of my public projects:
Sphinx Bootstrap Theme: This project, with a dark top navbar, using the theme option 'navbar_class': "navbar navbar-inverse",.
Django Cloud Browser: A Django reusable app for browsering cloud (e.g., Amazon Web Services S3) datastores.
Installation
The theme can be installed from PyPI or downloaded as a zip file from GitHub.
Install from PyPI
Install the package:
$ pip install sphinx_bootstrap_theme
Edit the “conf.py” configuration file to point to the bootstrap theme:
# At the top. import sphinx_bootstrap_theme # ... # Activate the theme. html_theme = 'bootstrap' html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
Download from GitHub
To install the theme, download the theme directory and update your configuration
Create a “_themes” directory in your project source root.
Get the “bootstrap” themes either as raw files or as a zipfile from the repository.
Most current way is to just clone this repo or download the full repo source and move the “bootstrap” directory to “_themes”.
Alternatively, there are some prepackaged theme zip files (containing only the theme files), which can be read directly by Sphinx. See the repo downloads page for available packages. Then download “bootstrap.zip”:
$ cd /path/to/_themes $ wget https://github.com/downloads/ryan-roemer/sphinx-bootstrap-theme/bootstrap.zip
In addition to the “current” release, the GitHub zipfiles have either git hash releases (for development builds) or tags for official tagged releases. E.g.:
bootstrap.zip bootstrap-v0.0.6.zip bootstrap-f51d73491e9bae68eb1b1c57059d9e0ece03d125.zip
Edit the “conf.py” configuration file to point to the bootstrap theme:
# Activate the theme. sys.path.append(os.path.abspath('_themes')) html_theme = 'bootstrap' html_theme_path = ['_themes']
Customization
The theme can be further customized with the following options by editing the “conf.py” configuration:
# (Optional) Use a shorter name to conserve nav. bar space. html_short_title = "Demo" # (Optional) Logo. Should be exactly 24x24 px to fit the nav. bar. # Path should be relative to the static files directory. html_logo = "my_logo.png" # Theme options are theme-specific and customize the look and feel of a # theme further. html_theme_options = { # HTML navbar class (Default: "navbar") to attach to <div> element. # For black navbar, do "navbar navbar-inverse" 'navbar_class': "navbar navbar-inverse", # Fix navigation bar to top of page? # Values: "true" (default) or "false" 'navbar_fixed_top': "true", # Location of link to source. # Options are "nav" (default), "footer" or anything else to exclude. 'source_link_position': "nav", }
Theme Notes
Sphinx
The theme places the global TOC, local TOC, navigation (prev, next) and source links all in the top Bootstrap navigation bar, along with the Sphinx search bar on the left side.
The global (site-wide) table of contents is the “Site” navigation dropdown, which is a multi-level deep rendering of the toctree for the entire site. The local (page-level) table of contents is the “Page” navigation dropdown, which is a multi-level rendering of the current page’s toc.
Generally speaking, this is a quick and dirty hack to get the basic theme going, so there are likely some oversights and lurking issues. Help and bug filings for the project are most welcome.
Bootstrap
The theme uses Twitter Bootstrap v2.2.1. You can override any static JS/CSS files by dropping different versions in your Sphinx “_static” directory.
Licenses
Sphinx Bootstrap Theme is licensed under the MIT license.
Twitter Bootstrap is licensed under the Apache license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for sphinx-bootstrap-theme-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bcb1777470e5ee1b2915a2dbf51780afd7f9423b63e513ca7156f434a961a333 |
|
MD5 | 4118cc6ca785433faabe34ad4f5376cb |
|
BLAKE2b-256 | 60fda0ed4dc5c2598955b52674e447fce61725c4c1c91015fb6e35e6d5c5eb7a |