Alternative representation of the code blocks
2 files changed
tree: f6de8dbc517882cbebdc15cdff324f3337f49dad
  1. .gitignore
  2. conf.py
  3. data.rst
  4. face.rst
  5. index.rst
  6. interest.rst
  7. Makefile
  8. name.rst
  9. README.md
  10. signature.rst
README.md

Prerequisites

To "compile" documentation into html form you would need to install Sphinx documentation package, which should be relatively trivial.

If you're on OSX platform:

If you're on Ubuntu Linux:

sudo apt-get install python-sphinx

Compilation

Just type

make html

And a set of HTML pages will be build under _build/html

You can also type

make latexpdf

This way Sphinx will prepare .tex file and will try to build .pdf document.