6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-12-13 06:37:46 +00:00
tutor/docs/tutor.rst
2019-02-18 09:22:41 +01:00

47 lines
804 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
Releasing a new version
-----------------------
- Bump the ``__version__`` value in ``tutor/__about__.py``.
- Replace "Latest" by the version name in CHANGELOG.md.
- Upgrade the tutor version for the cloud.
- Create a commit with the version changelog.
- ``git push``
- ``make tag TAG=vxxx``