Module Expr Str ImportFrom alias alias Import alias Import alias Import alias Import alias ImportFrom alias alias Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad FunctionDef arguments args NameParam defaults body With Call NameLoad NameLoad keyword Str NameStore body Assign NameStore Call AttributeLoad NameLoad attr Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Assign NameStore Call NameLoad NameLoad If NameLoad body Assign NameStore BinOpAdd BinOpAdd BinOpAdd BinOpAdd BinOpMult NameLoad NameLoad Str NameLoad Str BinOpMult NameLoad NameLoad orelse Assign NameStore BinOpAdd BinOpAdd NameLoad Str BinOpMult NameLoad NameLoad Return NameLoad decorator_list FunctionDef arguments args defaults body Expr Str Assign NameStore Call AttributeLoad Call NameLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Str attr Str Assign NameStore Call AttributeLoad NameLoad attr Str Assign NameStore Call AttributeLoad Str attr SubscriptLoad NameLoad Slice BinOpAdd NameLoad Num Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults Str body Expr Str Assign NameStore Call AttributeLoad NameLoad attr ListLoad NameLoad Str Str Str Str NameLoad keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr Expr Call NameLoad Str Assign TupleStore NameStore NameStore Call AttributeLoad NameLoad attr With Call NameLoad NameLoad Str keyword Str NameStore body Assign NameStore NameLoad For NameStore Call AttributeLoad Call AttributeLoad NameLoad attr Str attr AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr Str Str NameLoad If Call AttributeLoad NameLoad attr Str body Expr Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr Str If UnaryOpNot Call AttributeLoad NameLoad attr Str body Assign NameStore NameLoad orelse If BoolOpAnd NameLoad CompareEq NameLoad Str body Assign NameStore NameLoad Continue orelse Expr Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr Str If NameLoad body Expr Call NameLoad Str NameLoad If BoolOpAnd Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad CompareGt AttributeLoad Call AttributeLoad NameLoad attr NameLoad attr Num body Expr Call NameLoad Call AttributeLoad Str attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam defaults NameLoad body Expr Str Assign NameStore Call AttributeLoad Str attr Call AttributeLoad NameLoad attr Str With Call NameLoad NameLoad Str keyword Str NameStore body Expr Call NameLoad Str NameLoad Expr Call NameLoad Str NameLoad Expr Call NameLoad Str NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr NameLoad keyword AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr keyword NameLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Expr Call AttributeLoad NameLoad attr Call NameLoad NameLoad Str keyword NameLoad Expr Call AttributeLoad NameLoad attr NameLoad If CompareIn Str NameLoad body Assign NameStore Call AttributeLoad Str attr SubscriptLoad NameLoad Slice Num For NameStore NameLoad body If Call AttributeLoad Call AttributeLoad NameLoad attr attr Str body Expr Call NameLoad Call AttributeLoad Str attr NameLoad orelse If Call AttributeLoad Call AttributeLoad NameLoad attr attr Str body Expr Call NameLoad Call AttributeLoad Str attr NameLoad orelse If Call AttributeLoad Call AttributeLoad NameLoad attr attr Str body Expr Call NameLoad Call AttributeLoad Str attr NameLoad orelse If Call AttributeLoad Call AttributeLoad NameLoad attr attr Str body Expr Call AttributeLoad NameLoad attr BinOpMult Num Str If NameLoad body Expr Call AttributeLoad NameLoad attr BinOpAdd Str Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr Str orelse Expr Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr Str If CompareIn Str NameLoad body Expr Call AttributeLoad NameLoad attr Call NameLoad Str Str Expr Call AttributeLoad NameLoad attr Call NameLoad Expr Call NameLoad Call AttributeLoad Str attr NameLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults NameLoad NameLoad body Expr Str If NameLoad body Assign NameStore Call NameLoad Str Expr Call NameLoad Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Str Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Str keyword NameLoad If NameLoad body Assign NameStore Call NameLoad Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Str Str Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Str Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Str Str Str Assign NameStore ListLoad TupleLoad NameLoad ListLoad NameLoad Str NameLoad Str TupleLoad NameLoad ListLoad NameLoad Str NameLoad Str For TupleStore NameStore NameStore NameStore NameStore NameLoad body Expr Call NameLoad NameLoad NameLoad NameLoad NameLoad keyword NameLoad decorator_list If CompareEq NameLoad Str body Expr Str Expr Call NameLoad keyword NameLoad keyword NameLoad
N/A N/A Prepare docs (usually called by Makefile). __future__ unicode_literals print_function N/A os N/A re N/A subprocess N/A time textblob_de.compat _open get_external_executable N/A _HERE N/A N/A N/A os path dirname __file__ read N/A N/A fname N/A N/A N/A N/A _open fname encoding utf-8 fp N/A N/A content N/A N/A fp read N/A content N/A get_rst_title N/A N/A string symbol overline N/A False N/A N/A n N/A len string N/A overline N/A N/A string N/A N/A N/A N/A N/A n symbol string N/A n symbol N/A N/A string N/A N/A string N/A n symbol N/A string N/A get_credits N/A N/A N/A N/A N/A Extract credits from `AUTHORS.rst` N/A credits N/A N/A N/A read N/A N/A N/A os path join _HERE AUTHORS.rst split N/A from_index N/A N/A credits index Active Contributors N/A credits N/A N/A join N/A credits N/A N/A from_index 2 N/A credits N/A rst2markdown_github N/A N/A path_to_rst path_to_md pandoc N/A pandoc N/A N/A 
    Converts ``rst`` to **markdown_github**, using :program:`pandoc`

    **Input**

        * ``FILE.rst``

    **Output**

        * ``FILE.md``

     N/A _proc N/A N/A subprocess Popen N/A pandoc -f rst -t markdown_github path_to_rst stdout N/A subprocess PIPE stderr N/A subprocess PIPE N/A N/A print Converting README.rst to markdown_github, using 'pandoc' ... N/A N/A _stdout _stderr N/A N/A _proc communicate N/A N/A _open path_to_md w encoding utf-8 _md N/A N/A _skip_newline False N/A line N/A N/A N/A N/A _stdout decode utf-8 split N/A os linesep N/A N/A line N/A N/A re sub ``` sourceCode ``` python line N/A N/A N/A line startswith [![ N/A N/A N/A N/A _md write line N/A N/A N/A _md write N/A N/A N/A N/A line startswith [![LICENSE N/A N/A _skip_newline True N/A N/A N/A _skip_newline N/A line N/A N/A _skip_newline False N/A N/A N/A N/A N/A _md write line N/A N/A N/A _md write N/A _stderr N/A N/A N/A print pandoc.exe STDERR:  _stderr N/A N/A N/A N/A N/A os path isfile path_to_md N/A N/A N/A N/A os stat path_to_md st_size 0 N/A N/A N/A print N/A N/A README.rst converted and saved as: {} format path_to_md N/A console_help2rst N/A N/A cwd help_cmd path_to_rst rst_title format_as_code N/A False N/A N/A 
    Extract HELP information from ``<program> -h | --help`` message

    **Input**

        * ``$ <program> -h | --help``
        * ``$ cd <cwd> && make help``

    **Output**

        * ``docs/src/console_help_xy.rst``

     N/A generated_time_str N/A N/A 

    ::

     generated: {0}

 format N/A N/A time strftime %d %B %Y - %H:%M N/A N/A _open path_to_rst w encoding utf-8 f N/A N/A N/A print File f N/A N/A print cwd cwd N/A N/A print help_cmd help_cmd N/A N/A N/A os chdir cwd N/A _proc N/A N/A subprocess Popen help_cmd stdout N/A subprocess PIPE stderr N/A subprocess STDOUT universal_newlines True N/A help_msg N/A N/A N/A _proc stdout readlines N/A N/A N/A f write N/A get_rst_title rst_title - overline True N/A N/A N/A f write generated_time_str N/A N/A README path_to_rst N/A N/A help_msg N/A N/A join N/A help_msg N/A 10 N/A line help_msg N/A N/A N/A N/A N/A N/A line strip startswith make[1]: N/A N/A N/A print N/A N/A skipped line: {} format line N/A N/A N/A N/A N/A N/A line strip startswith [1m N/A N/A N/A print N/A N/A skipped line: {} format line N/A N/A N/A N/A N/A N/A line strip startswith Using fallback version of ' N/A N/A N/A print N/A N/A skipped line: {} format line N/A N/A N/A N/A N/A N/A line strip startswith --> N/A N/A N/A N/A f write N/A 3 N/A format_as_code N/A N/A N/A N/A f write N/A N/A N/A line strip N/A N/A N/A f write N/A N/A N/A N/A f write line N/A N/A N/A f write N/A N/A README path_to_rst N/A N/A N/A N/A f write N/A get_rst_title Credits ^ N/A N/A N/A f write N/A get_credits N/A N/A print N/A N/A 
cmd:{} in dir:{} --> RST generated:
	{}

 format help_cmd cwd path_to_rst N/A update_docs N/A N/A readme makefiles N/A True True N/A N/A Update documentation (ready for publishing new release)

    Usually called by ``make docs``

    :param bool make_doc: generate DOC page from Makefile help messages

     N/A readme N/A N/A _pandoc N/A get_external_executable pandoc N/A N/A rst2markdown_github N/A N/A N/A os path join _HERE README.rst N/A N/A N/A os path join _HERE README.md pandoc _pandoc N/A makefiles N/A N/A _make N/A get_external_executable make N/A project_makefile_dir N/A N/A N/A os path abspath _HERE N/A project_makefile_rst N/A N/A N/A os path join _HERE docs src project_makefile.rst N/A docs_makefile_dir N/A N/A N/A os path join _HERE docs src N/A docs_makefile_rst N/A N/A N/A os path join _HERE docs src docs_makefile.rst N/A help2rst_queue N/A N/A project_makefile_dir N/A _make help project_makefile_rst Project ``Makefile`` N/A docs_makefile_dir N/A _make help docs_makefile_rst Documentation ``Makefile`` N/A N/A cwd help_cmd outfile title help2rst_queue N/A N/A N/A console_help2rst cwd help_cmd outfile title format_as_code True N/A N/A N/A __name__ __main__ N/A N/A Usually called by Makefile. N/A N/A update_docs readme True makefiles True