6
0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-10 23:30:59 +00:00
tutor/docs/index.rst
Régis Behmo 07ae8d472f docs: generate reference docs automatically
This is performed with the help of sphinx-click:
https://sphinx-click.readthedocs.io
2021-10-14 12:59:57 +02:00

55 lines
1.5 KiB
ReStructuredText

.. include:: ../README.rst
:start-after: _readme_intro_start:
:end-before: _readme_intro_end:
.. image:: ./img/quickstart.gif
:alt: Tutor local quickstart
:target: https://terminalizer.com/view/91b0bfdd557
----------------------------------
.. include:: testimonials.rst
----------------------------------
.. include:: quickstart.rst
:start-line: 1
.. toctree::
:maxdepth: 2
:caption: User guide
gettingstarted
run
configuration
plugins
reference
tutorials
troubleshooting
tutor
faq
Source code
-----------
The complete source code for Tutor is available on Github: https://github.com/overhangio/tutor
.. include:: ../README.rst
:start-after: _readme_support_start:
:end-before: _readme_support_end:
.. include:: ../README.rst
:start-after: _readme_contributing_start:
:end-before: _readme_contributing_end:
License
-------
This work is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor/blob/master/LICENSE.txt>`_.
The AGPL license covers the Tutor code, including the Dockerfiles, but not the content of the Docker images which can be downloaded from https://hub.docker.com. Software other than Tutor provided with the docker images retain their original license.
The Tutor plugin system is licensed under the terms of the `Apache License, Version 2.0 <https://opensource.org/licenses/Apache-2.0>`__.
© 2021 Tutor is a registered trademark of SASU NULI NULI. All Rights Reserved.