diff options
| author | jwansek <eddie.atten.ea29@gmail.com> | 2022-05-01 16:03:24 +0100 |
|---|---|---|
| committer | jwansek <eddie.atten.ea29@gmail.com> | 2022-05-01 16:03:24 +0100 |
| commit | abc7f067ff20bc2bd07d9236c30055549481547c (patch) | |
| tree | d486cb4efda107633bcf243e5f60fdebd7094e5f /docs/source/reflect.rst | |
| parent | ee1b57ec6197c554f3c011f9a648e2222d845994 (diff) | |
| download | Smarker-abc7f067ff20bc2bd07d9236c30055549481547c.tar.gz Smarker-abc7f067ff20bc2bd07d9236c30055549481547c.zip | |
Finished plagarism detector, added docs
Diffstat (limited to 'docs/source/reflect.rst')
| -rw-r--r-- | docs/source/reflect.rst | 23 |
1 files changed, 21 insertions, 2 deletions
diff --git a/docs/source/reflect.rst b/docs/source/reflect.rst index c059206..6c0767a 100644 --- a/docs/source/reflect.rst +++ b/docs/source/reflect.rst @@ -1,5 +1,24 @@ ``reflect.py``: Getting information about code ============================================== -.. automodule:: reflect - :members:
\ No newline at end of file +Classes +******* + +.. autoclass:: reflect.Reflect + :members: + +.. autoexception:: reflect.MonitoredFileNotInProducedFilesException + +Thrown if the user has tried to monitor a file that isn't in the list of produced files in the :ref:`assessmentyaml`. + +Functions +********* + +.. autofunction:: reflect.gen_reflection_report + +Generates a json file report. It is quite a complex structure, but it is made so users can add other rendering templates +later on. For example, the :ref:`quickstart` looks like this: + +.. literalinclude:: _static/simple.json + :linenos: + :language: yaml
\ No newline at end of file |