Documentation
I have used several types of documentation in this project to assist the student developers understand the software.
- An extensive guide to implementing SIP in Python (still incomplete) is available in both PDF and HTML formats. I recommend this document if you want to walk through various modules in the implementation, or understand various design decisions and intricate details of why something is implemented in a certain way. The document takes you through pretty much every line of code in the implementation.
- The Python documentation either using the comments or docstring present in the source code itself.
- The documentation extracted from the corresponding specification in the htmlified source code. Click on Browse Source on the left menu.
