CaptsLog

Journal Application using python

Specific package information:

• Python 2.7
• PyQt4
• Pyside
• Pymongo
• Markdown

Project Documentation

Github Page

Documentation

CaptsLog uses sphinx for its documentation need with extension of napoleon(google docstring convention).

Github offers github pages. Github pages for CaptsLog can be access through this url or to view source code go to gh-pages branch of this documentation.

After following google docstring convention.

Go to docs/ directory on the repository and run following command:

Linux/OS X

$ make html

Windows

$ makefile.bat html

Attention Contributors (Documentation)

Contributors should run following command after they have chagned/created snippets with documentation.

This command should be run while contributors are in docs directory.

sphinx-apidoc -f -o source/ ../captslog