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/assessments.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/source/assessments.rst (limited to 'docs/source/assessments.rst') diff --git a/docs/source/assessments.rst b/docs/source/assessments.rst new file mode 100644 index 0000000..a8d7311 --- /dev/null +++ b/docs/source/assessments.rst @@ -0,0 +1,24 @@ +.. _assessments: + +``assessments.py`` +================== + +``assessments.py`` contains many useful arguments for interacting with the database: + +.. argparse:: + :module: assessments + :func: getparser + :prog: python Smarker/assessments.py + +Classes +******* + +.. autoclass:: assessments.SimilarityMetric + :members: + +Functions +********* + +.. autofunction:: assessments.visualise_matrix + +.. autofunction:: assessments.generate_plagarism_report \ No newline at end of file -- cgit v1.2.3