vacca.doc module

this module will be used to document lots of things, it parses existing modules and generate the .rst files

Functions

get_autodoc

vacca.doc.get_autodoc(module_name, module_scope, module_vars=[], module_doc='', module_postdoc='\n----\n')[source]

generate_rest_files

vacca.doc.generate_rest_files(path='source')[source]

get_vars_docs

vacca.doc.get_vars_docs(module_name, module_vars, title='Variables', subtitle=True)[source]

get_function_docs

vacca.doc.get_function_docs(module_name, module_vars, title='Functions', subtitle=True)[source]

get_class_docs

vacca.doc.get_class_docs(module_name, module_vars, title='Classes', subtitle=True)[source]

get_rest_title

vacca.doc.get_rest_title(string, char='=', double_line=False)[source]

vacca.doc.generate_rest_files(path='source')[source]
vacca.doc.get_autodoc(module_name, module_scope, module_vars=[], module_doc='', module_postdoc='\n----\n')[source]
vacca.doc.get_class_docs(module_name, module_vars, title='Classes', subtitle=True)[source]
vacca.doc.get_function_docs(module_name, module_vars, title='Functions', subtitle=True)[source]
vacca.doc.get_rest_title(string, char='=', double_line=False)[source]
vacca.doc.get_vars_docs(module_name, module_vars, title='Variables', subtitle=True)[source]