Sphinx HEIG-VD Theme

This theme is a fork of the sphinx-press-theme based on VuePress. It uses Vue.js & Stylus managed by webpack (through vue-cli).

Installation

First install the theme:

$ pip install git+https://github.com/heig-vd-tin/sphinx-heigvd-theme

On Sphinx project's conf.py: set the theme name to heigvd.

html_theme = "heigvd"

See details on Sphinx theming docs.

Development

To contribute to this theme you should first build the web assets:

cd ui
npm run build

Sphinx theme has a soft link to built assets. Once done, install the theme locally with pip install -e ..

docs folder contains theme's own documentantion.

cd docs
make clean; make html