diff options
Diffstat (limited to 'docs/source/index.rst')
| -rw-r--r-- | docs/source/index.rst | 29 |
1 files changed, 25 insertions, 4 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst index 4da39e2..e36cc86 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -6,6 +6,30 @@ Setting up * Set up a MySQL/MariaDB server. The database will be generated automatically. * Add ``smarker.conf`` to the root directory of the code. See :ref:`configfile` for the structure of this file. * Decide how you want to run the program: with or without docker. +* Add an assessment yaml- :ref:`assessmentyaml`. +* Enroll students: ``python3 Smarker/assessments.py -s 123456789,Eden,Attenborough,E.Attenborough@uea.ac.uk`` + +``smarker.py`` usage +******************** + +Now we are ready to make some reports! For which we use the main file ``smarker.py``: + +.. argparse:: + :module: smarker + :func: getparser + :prog: python Smarker/smarker.py + +Please note that the ``-o`` flag is required for rendering to PDFs. + +``assessments.py`` usage +************************ + +``assessments.py`` contains many useful arguments for interacting with the database: + +.. argparse:: + :module: assessments + :func: getparser + :prog: python Smarker/assessments.py .. toctree:: :maxdepth: 2 @@ -20,10 +44,7 @@ Setting up configfile.rst docker.rst - - - - + assessmentyaml.rst Indices and tables ================== |