From f2f734194c03dfff2024cf417c502515ddb7a855 Mon Sep 17 00:00:00 2001 From: jwansek Date: Sat, 21 May 2022 22:38:52 +0100 Subject: Added running as an API --- docs/source/index.rst | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) (limited to 'docs/source/index.rst') diff --git a/docs/source/index.rst b/docs/source/index.rst index f2d7426..80fefaf 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,6 +11,9 @@ Setting up * Add an assessment yaml- :ref:`assessmentyaml`. * Enroll students: ``python3 Smarker/assessments.py -s 123456789,Eden,Attenborough,E.Attenborough@uea.ac.uk`` +*Smarker* can be used inside docker, see :ref:`docker` (recommended for sandboxing client code) +and through an API- see :ref:`api`. + ``smarker.py`` usage ******************** @@ -37,20 +40,28 @@ Also see :ref:`assessments` .. toctree:: :maxdepth: 2 + :caption: Setting up: + + quickstart.rst + configfile.rst + +.. toctree:: + :maxdepth: 3 + :caption: Docker: + + docker.rst + assessmentyaml.rst + api.rst + +.. toctree:: + :maxdepth: 3 :caption: Modules: reflect.rst database.rst assessments.rst + api.rst -.. toctree:: - :maxdepth: 2 - :caption: Other Pages: - - quickstart.rst - configfile.rst - docker.rst - assessmentyaml.rst Indices and tables ================== -- cgit v1.2.3