Helloworld project index html

This is an example for making code documentation.

• 1. helloworld_module
  • 1.1. Overview
  • 1.2. Example Usage
  • 1.3. Functions and Classes

Installation and Usage

To download and install the package on OS X, run the following commands (this will require your password to install, as well as a log-in to the Git server):

$ git clone ssh://<YOUR_NAME>@immenseirvine.uchicago.edu/git/helloworld
$ cd helloworld
$ sudo python setup.py develop

Note that develop here means that symbolic links will be added to your packages directory instead of a hard, immutable copy. Updates can be installed running the following command from the helloworld directory:

$ git pull

If you have installed the module in develop mode, as above, you don’t need to re-run setup to use the new version. This is why ``develop`` is better than ``install``.

Once the package has been developed, all the sub-modules (in this case, there is only one) will be available as members of the helloworld package. For example:

from helloworld import helloworld_module      #module will appear as 'helloworld_module'
import helloworld.helloworld_module           #module will appear as 'helloworld.helloworld_module'
import helloworld.helloworld_module as hw     #module will appear as 'hw'

hw_class_instance = hw.HelloWorld()

output = hw.helloworld()

Dependencies

There are no external modules used by helloworld.