Help

Contact

Need help, found a bug or other issue? Write an email to buchere at ohsu edu.

How-to Contribute?

You would like contribute the the project? Great! The following lines should get your ready.

Code

Documentation

Documentation is written in restructured text format. Have a look at this sphinx doc rest primer, if you never have worked with restructured text format before.

The documatation source code is at annot/docs/source. Some of the module doccumenation happens directly in the docstings!

For working at the documenation you have to add the annot you your python path and install sphinx.

export PYTHONPATH=/path/to/sourcecode/annot/web:$PYTHONPATH
pip install sphinx

You need to know the follow commands to work efficiently on the documenation code.

cd annot/docs   # change directory to the docs folder
make html   # build a new documentation html version out of the source
open build/html/index.html  # opens the latest index file in your web browser
  • Spell-check.
  • No trailing whitespaces.
  • Limit all lines to a maximum of 79 characters.
  • And don’t forget to add you self to the author list.