Welcome to my_package’s documentation!

Here is where you can write the documentation for your package.

Usage

Installation

To use my_package you need to install X, Y and Z.

Code

Here is an example of describing the use of your function.

To add one to a number you can use the my_package.add_one() function:

my_package.add_one(number)

param number:

Should be integer, floating point number or a string.

If number is not one of these types, an exception will be raised:

exception TypeError

Raised if the input is invalid.

More about how to describe code can be hound here

Indices and tables

• Index

• Module Index

• Search Page

my_package.example Module

Functions

add_one(number)

Example of a simple function.