hbp-sphinx-theme 0.3.4

Human Brain Project Sphinx Theme.

HBP Collaboratory Sphinx Theme

Contents

• HBP Collaboratory Sphinx Theme

  • Installation

    • Via package

    • Via download

  • Contributing or modifying the theme

  • Build and release the theme

View a working demo over on collaboratory.

This package provide a Sphinx theme for documentation integrated into the Collaboratory. It can be used for standalone websites as well.

Installation

Via package

Download the package or add it to your requirements.txt file:

pip install hbp_sphinx_theme

In your conf.py file:

import hbp_sphinx_theme
html_theme = "hbp_sphinx_theme"
html_theme_path = [hbp_sphinx_theme.get_html_theme_path()]

Via download

Download the hbp_sphinx_theme.zip provided by the latest release to your documentation project directory.

As explained in sphinx documentation, in your conf.py file:

html_theme = 'hbp_sphinx_theme'
html_theme_path = ['.']

Contributing or modifying the theme

HBP Collaboratory Sphinx Theme github project can be included in your documentation project as a git submodule. This will enable you to modify the theme and see the changes immediately in your browser. Please have a look at the documentation example project on how to set up. After you are happy with the changes, you’ve made to the theme, please make a pull request for us to review.

Build and release the theme

The build and release is done using grunt.

grunt release

Changelog