Module Expr Str Assign NameStore Str Assign NameStore Str Import alias alias ImportFrom alias alias alias ImportFrom alias ImportFrom alias ImportFrom alias FunctionDef arguments args NameParam defaults body Expr Call AttributeLoad NameLoad attr Str NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam defaults body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad With Call NameLoad NameLoad NameStore body Assign NameStore Call AttributeLoad Call AttributeLoad NameLoad attr attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad If CompareEq NameLoad NameLoad body Return ListLoad Assign NameStore ListLoad NameLoad Call AttributeLoad Str attr Call NameLoad NameLoad Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Expr Call AttributeLoad NameLoad attr BinOpMod Str TupleLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Str Expr Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr Str Assign TupleStore NameStore NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad AugAssignAdd NameStore Str If CompareNotEq NameLoad NameLoad body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad If Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad body Expr Call AttributeLoad NameLoad attr Str Expr Call AttributeLoad NameLoad attr BinOpAdd Str NameLoad Expr Call AttributeLoad NameLoad attr Str Expr Call AttributeLoad NameLoad attr Str Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults body Assign NameStore ListLoad Print BinOpAdd Str NameLoad For TupleStore NameStore NameStore NameStore Call AttributeLoad NameLoad attr NameLoad body For NameStore NameLoad body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad If UnaryOpNot Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad body Continue Assign TupleStore NameStore NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad If CompareNotEq NameLoad Str body Continue Print BinOpAdd Str NameLoad AugAssignAdd NameStore Call NameLoad NameLoad NameLoad NameLoad NameLoad Return Call AttributeLoad Str attr NameLoad decorator_list ClassDef bases NameLoad body Assign NameStore Num Assign NameStore Dict Str NameLoad FunctionDef arguments args NameParam defaults body Assign NameStore Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr BinOpSub BinOpSub AttributeLoad NameLoad attr AttributeLoad AttributeLoad NameLoad attr attr Num Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr SubscriptLoad AttributeLoad NameLoad attr Index Num Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore NameLoad Assign NameStore NameLoad If CompareIn Str AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad SubscriptLoad AttributeLoad NameLoad attr Index Str Assign NameStore SubscriptLoad AttributeLoad NameLoad attr Index Str Assign NameStore Call NameLoad NameLoad NameLoad NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad AttributeLoad AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr attr keyword NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad NameLoad Return ListLoad decorator_list decorator_list
N/A N/A This sphinx helper module parse docstrings of python files in a folder and 
put in a document.

It takes a folder and extract the top level docstrings for each .py file 
found. It will also look inside the (optional) image folder for a .png file 
with the same name and if exists add that as an illustration of the python 
file.

Typical use (copied from pymunk examples)::
    
    .. autoexample:: ../../examples
        :image_folder: _static/examples

 N/A __version__ $Id:$ N/A __docformat__ reStructuredText N/A ast os docutils nodes statemachine utils docutils.parsers.rst Directive docutils.parsers.rst directives docutils.nodes fully_normalize_name setup N/A N/A app N/A N/A N/A N/A N/A app add_directive autoexample AutoExampleDirective N/A parse_example N/A N/A basepath filename img_folder img_folder_os N/A N/A N/A path N/A N/A N/A os path join basepath filename N/A N/A open path f N/A N/A content N/A N/A N/A N/A f read strip N/A n N/A N/A ast parse content N/A docstring N/A N/A ast get_docstring n N/A N/A docstring None N/A N/A N/A N/A s N/A filename N/A N/A ljust N/A len filename - N/A folder N/A N/A N/A os path basename basepath N/A N/A N/A s append N/A Location: *%s/%s* N/A folder filename N/A N/A N/A s append N/A N/A N/A s append docstring N/A N/A N/A s append N/A N/A img_name _ N/A N/A N/A os path splitext filename N/A img_name .png N/A N/A img_folder None N/A N/A img_path N/A N/A N/A os path join img_folder img_name N/A img_path_os N/A N/A N/A os path join img_folder_os img_name N/A N/A N/A N/A os path isfile img_path_os N/A N/A N/A N/A s append N/A N/A N/A s append N/A .. image::  img_path N/A N/A N/A s append N/A N/A N/A s append N/A s N/A parse_examples N/A N/A path img_folder img_folder_os N/A N/A N/A lines N/A N/A N/A autoexample: documenting files in  path N/A N/A root dirs files N/A N/A os walk path N/A N/A file files N/A N/A path N/A N/A N/A os path join root file N/A N/A N/A N/A N/A os path isfile path N/A N/A N/A N/A _ ext N/A N/A N/A os path splitext path N/A N/A ext .py N/A N/A N/A N/A autoexample: documenting  file N/A lines N/A parse_example root file img_folder img_folder_os N/A N/A N/A join lines N/A AutoExampleDirective N/A Directive N/A N/A required_arguments 1 N/A option_spec N/A image_folder str run N/A N/A self N/A N/A N/A source N/A N/A N/A N/A self state_machine input_lines source N/A N/A N/A self lineno N/A N/A self state_machine input_offset 1 N/A source_dir N/A N/A N/A os path dirname N/A N/A N/A os path abspath source N/A path N/A N/A directives path N/A N/A self arguments N/A 0 N/A path N/A N/A N/A os path normpath N/A N/A N/A os path join source_dir path N/A path N/A N/A utils relative_path None path N/A path N/A N/A nodes reprunicode path N/A img_folder None N/A img_folder_os None N/A N/A image_folder N/A self options N/A N/A img_folder_os N/A N/A N/A os path normpath N/A N/A N/A os path join source_dir N/A N/A self options N/A image_folder N/A img_folder N/A N/A self options N/A image_folder N/A rawtext N/A parse_examples path img_folder img_folder_os N/A include_lines N/A N/A statemachine string2lines rawtext N/A N/A N/A N/A self state document settings tab_width convert_whitespace True N/A N/A N/A N/A self state_machine insert_input include_lines path N/A N/A N/A N/A