hachibee-sphinx-theme

a simple sphinx theme


Keywords
sphinx, theme
License
MIT
Install
pip install hachibee-sphinx-theme==0.1.8

Documentation

Sphinx hachibee theme

Sample Page of HEAD revision

http://hachibeedi.github.io/Sphinx-hachibee-theme/index.html

Characteristic

  • Simple and clean color combinations.
  • Japanese friendly font declaration.
  • Responsive stylings.

ScreenShot

https://raw.github.com/hachibeeDI/Sphinx-hachibee-theme/master/example/screenshot.png

Installation

pip install hachibee-sphinx-theme

How to use

change conf.py in your sphinx source directory

How to tweak the style

If you don't like some styles(eg: font-size, font-family), You can add your own stylesheets.

First, you should add function setup is in your local conf.py.

# conf.py

def setup(app):
    app.add_stylesheet('custom.css')

Second, create your stylesheet in _static. Directory named _static is created on the root directory in your sources.

This is sample to remove button to back top is as below.

echo "#raise-top {display: none; }" > source/_static/custom.css

Lastly, you apply the alteration to your project.

make clean && make html

LICENCE

MIT