Basicstrap Theme

See also

• http://pythonhosted.org/sphinxjp.themes.basicstrap/

• https://github.com/tell-k/sphinxjp.themes.basicstrap

Contents

• Basicstrap Theme

  • Introduction

  • Features

  • Set up

  • Convert Usage

  • Requirement

  • Using

  • License

Introduction

Basicstrap style theme for Sphinx.

Features

• provide basicstrap theme for render HTML document.

• using Twitter Bootstrap.

• support Responsive Design.

• change the layout flexibility.

• Google Web Fonts available.

• Font Awesome available.

• easily change the design. by Bootswatch.

Set up

Make environment with pip:

$ pip install sphinxjp.themes.basicstrap

Make environment with easy_install:

$ easy_install sphinxjp.themes.basicstrap

Convert Usage

setup conf.py with:

extensions = ['sphinxjp.themecore']
html_theme = 'basicstrap'

and run:

$ make html

Caution

Caution when upgrading from 0.1.1 to 0.2.0

• In version 0.1.1, the header color was black in the default, it has become white in 0.2.0.

• If you like the black color header, please set to True the ‘header_inverse’ option.

Requirement

• Python 2.7 or later (not support 3.x)

• Sphinx 1.1.x or later.

• sphinxjp.themecore 0.1.3 or later

Using

• Twitter Bootstrap 2.2.2

• jQuery 1.8.3

• Bootswatch

• Font Awesome 3.0

License

• sphinxjp.themes.basicstrap Licensed under the MIT license .

• Twitter Bootstrap is licensed under the Apache license.

• Bootswatch is licensed under the Apache license.

• Font Awesome is licensed unde the license.

See the LICENSE file for specific terms.