fandango.doc module¶

this module will be used to document lots of things with sphinx

to see more about sphinx generation, check fandango/scripts/generate-sphinx-docs.sh

Just do that at the end of your modules:

from fandango.doc import get_autodoc __doc__ = get_autodoc(__name__,vars())

Functions¶

get_autodoc¶

fandango.doc.get_autodoc(module_name, module_scope, module_vars=[], module_doc='', module_postdoc='\n----\n')[source]¶: from fandango import get_autodoc __doc__ = get_autodoc(__name__,vars())

generate_rest_files¶

fandango.doc.generate_rest_files(module, path='source')[source]¶

get_vars_docs¶

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

get_fn_autodoc¶

fandango.doc.get_fn_autodoc(module_name, module_scope, module_vars=[], module_doc='', module_postdoc='\n----\n')[source]¶

get_function_docs¶

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

get_class_docs¶

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

get_rest_title¶

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

fandango.doc.get_autodoc(module_name, module_scope, module_vars=[], module_doc='', module_postdoc='\n----\n')[source]: from fandango import get_autodoc __doc__ = get_autodoc(__name__,vars())

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

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

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