From abc7f067ff20bc2bd07d9236c30055549481547c Mon Sep 17 00:00:00 2001 From: jwansek Date: Sun, 1 May 2022 16:03:24 +0100 Subject: Finished plagarism detector, added docs --- docs/source/index.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/source/index.rst') diff --git a/docs/source/index.rst b/docs/source/index.rst index e36cc86..f2d7426 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,7 @@ .. mdinclude:: readme.md +Read the :ref:`quickstart`. + Setting up ---------- @@ -26,6 +28,8 @@ Please note that the ``-o`` flag is required for rendering to PDFs. ``assessments.py`` contains many useful arguments for interacting with the database: +Also see :ref:`assessments` + .. argparse:: :module: assessments :func: getparser @@ -37,11 +41,13 @@ Please note that the ``-o`` flag is required for rendering to PDFs. reflect.rst database.rst + assessments.rst .. toctree:: :maxdepth: 2 :caption: Other Pages: + quickstart.rst configfile.rst docker.rst assessmentyaml.rst -- cgit v1.2.3