Skip to main content

Human Brain Project Sphinx Theme.

Project description

https://travis-ci.org/HumanBrainProject/hbp-sphinx-theme.svg?branch=master

HBP Collaboratory Sphinx 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.

screen_integrated.png

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for hbp-sphinx-theme, version 0.3.4
Filename, size File type Python version Upload date Hashes
Filename, size hbp-sphinx-theme-0.3.4.tar.gz (384.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page