christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-05 21:07:50 +00:00
Code Issues Releases Activity
5df069f42a
tutor/docs/tutor.rst

37 lines
510 B
ReStructuredText
Raw Normal View History

Improve documentation
2018-12-26 15:00:47 +00:00
.. _tutor:
Tutor development
=================
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-01-22 20:25:04 +00:00
Start by cloning the Tutor repository::
Improve documentation
2018-12-26 15:00:47 +00:00
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-01-22 20:25:04 +00:00
git clone https://github.com/regisb/tutor.git
cd tutor/
Improve documentation
2018-12-26 15:00:47 +00:00
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-01-22 20:25:04 +00:00
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
Copy Permalink