summaryrefslogtreecommitdiffstats
path: root/docs/source/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source/index.rst')
-rw-r--r--docs/source/index.rst27
1 files changed, 19 insertions, 8 deletions
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
==================