write_folder

Creates the documentation for the contents in a folder.

It checks that the file folder is not in the ignore_list. If there is a subfolder in the folder, this gets opened, written and an index file is created.

param folder

Absolute path to folder

type folder

str

param ignore_list

List with filenames and folders to ignore and skip

type ignore_list

list

returns

Tuple containing the title and body of the docstring found for it to be added to the index of the

current folder.

rtype

tuple