6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-16 18:15:09 +00:00
tutor/docs/tutor.rst
Régis Behmo 4331bc5712 Tutor v3 complete rewrite
Replace all make commands by a single "tutor" binary. Environment and
data are all moved to ~/.tutor/local/share/tutor. We take the
opportunity to add a web UI and revamp the documentation.

This is a complete rewrite.

Close #121.
Close #147.
2019-02-09 20:30:01 +01:00

37 lines
510 B
ReStructuredText

.. _tutor:
Tutor development
=================
Start by cloning the Tutor repository::
git clone https://github.com/regisb/tutor.git
cd tutor/
Install requirements
--------------------
::
pip install -r requirements/dev.txt
Bundle ``tutor`` executable
---------------------------
::
make bundle
Generate the documentation
--------------------------
::
pip install sphinx sphinx_rtd_theme
cd docs/
make html
You can then browse the documentation with::
make browse