Creating documentation

This document is created with sphinx. In order to recreate it at your place, you have to clone

  • clone the repository
  • open a terminal
  • change to the docs folder

Execute this commands:

cd docs
make html

This compiles the documentation and places the output into the _build folder.

Doctest blocks

>>> print('hello')
hello
>>> 1 + 2
3

Footnotes

This is a footnote reference [1].

Autonumbered footnotes are possible, like using [2] and [3].

[1]A numerical footnote.
[2]This is the first one.
[3]This is the second one.

External hyperlinks, like Cocos2D.

_images/flappy.png