Hyper Documentation

April 17, 2017 ยท View on GitHub

The Hyper documentation is built using Sphinx and reStructured Text.

Prerequisites

  • A TeX Distribution
  • virtualenv

Setup

# Change to this directory in your terminal
cd docs
virtualenv ENV
ENV/bin/activate
pip install -r requirements.txt

Building HTML

make html

Or, a handy live-reloading server for when you are writing documentation:

make livehtml

Building the PDF

make latexpdf

Contents

  1. 1Prerequisites
  2. 2Setup
  3. 3Building HTML
  4. 4Building the PDF