1. helloworld_module

This module is a placeholder module for demonstrating how to use Sphinx documentation.

1.1. Overview

helloworld_function()	Print ‘hello world’ and return string as output
HelloWorld()	Class containing printme method

1.2. Example Usage

Note that here, we assume helloworld is a globally installed package, containing the module helloworld, which contains a function and a class called helloworld and HelloWorld, respectively.

#!/usr/bin/env python
import helloworld_module from helloworld
    output = helloworld_module.helloworld_function()
    hw = helloworld_module.HelloWorld()

1.3. Functions and Classes

Placeholder module for demonstrating sphinx documentation

helloworld.helloworld_module.helloworld_function()

Print ‘hello world’ and return string as output

class helloworld.helloworld_module.HelloWorld

Class containing printme method

Methods

printme()	Print ‘hello world’, which is defined as the ‘output’ attribute
repeat(n)	Print ‘hello world’ n times

printme()

Print ‘hello world’, which is defined as the ‘output’ attribute

repeat(n)

Print ‘hello world’ n times