4. Code Documentation

Here comes the semi-automatically generated code documentation. For now the commands used are :

sphinx-apidoc -f -o source/code ../MatrixGUI
sphinx-apidoc -f -o source/code/Python ../MatrixGUI/Components/Python
sphinx-apidoc -f -o source/code/PyQt ../MatrixGUI/Components/PyQt

Note

In order to understand Google docstring format you have to use napoleon (see http://sphinx-doc.org/ext/napoleon.html#module-sphinx.ext.napoleon) This requires Sphinx 1.3.

• 4.1. MatrixGUI
  • 4.1.1. orchestrator module
  • 4.1.2. orchestratorSlots module
• 4.2. Python
  • 4.2.1. Persistence package
• 4.3. PyQt
  • 4.3.1. PictureFetcher package
  • 4.3.2. PictureManager package
  • 4.3.3. WorkspaceManager package