Name	Size	Mode	Actions
_screenshots/	-	0777	rm
_static/	-	0777	rm
conf.py	8002	0777	editdlrm
events.rst	1519	0777	editdlrm
i18n.rst	1615	0777	editdlrm
index.rst	3726	0777	editdlrm
keyboard.rst	1346	0777	editdlrm
make.bat	5124	0777	editdlrm
Makefile	5620	0777	editdlrm
markup.rst	2379	0777	editdlrm
methods.rst	4638	0777	editdlrm
options.rst	18621	0777	editdlrm
README.md	821	0777	editdlrm
requirements.txt	17	0777	editdlrm

Documentation ============= Project documentation is built using [Sphinx docs](http://sphinx-doc.org/), which uses [ReST](http://docutils.sourceforge.net/rst.html) for markup. This allows the docs to cover a vast amount of topics without using a thousand-line README file. Sphinx docs is pip-installable via `pip install sphinx`. Once installed, open a command line in the docs folder and run the following commands: ```bash $ sudo pip install -r requirements.txt ``` This will install the requirements needed for the generating the docs. Afterwards you can run: ```bash $ make html ``` The docs will be generated, the output files will be placed in the `_build/html/` directory, and can be browsed (locally) with any browser. The docs can also be found online at .