summaryrefslogtreecommitdiffstats
path: root/docs/source/index.rst
diff options
context:
space:
mode:
authorjwansek <eddie.atten.ea29@gmail.com>2022-05-01 16:03:24 +0100
committerjwansek <eddie.atten.ea29@gmail.com>2022-05-01 16:03:24 +0100
commitabc7f067ff20bc2bd07d9236c30055549481547c (patch)
treed486cb4efda107633bcf243e5f60fdebd7094e5f /docs/source/index.rst
parentee1b57ec6197c554f3c011f9a648e2222d845994 (diff)
downloadSmarker-abc7f067ff20bc2bd07d9236c30055549481547c.tar.gz
Smarker-abc7f067ff20bc2bd07d9236c30055549481547c.zip
Finished plagarism detector, added docs
Diffstat (limited to 'docs/source/index.rst')
-rw-r--r--docs/source/index.rst6
1 files changed, 6 insertions, 0 deletions
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