documentation_test package

Submodules

documentation_test.test module

Testing sphinx autodocumentation through read the docs

Extended description...

documentation_test.test.main()

This is the main function

Extended description...

Args:

Returns:

documentation_test.test.nothing(random_integer, random_string)

takes as input string, then prints it

Parameters:

• arg1 (int) – random integer
• arg2 (str) – random_string

Returns:

concatenation of arg1 and arg2 in string form

Return type:

str

documentation_test.test.test(string)

takes as input string, then prints it

Parameters:arg1 (str) – the input string Returns:nothing Return type:null

Module contents