Module Expr Str ImportFrom alias ImportFrom alias ImportFrom alias ImportFrom alias Import alias FunctionDef arguments args NameParam defaults body Return BinOpAdd BinOpAdd AttributeLoad NameLoad attr Str AttributeLoad NameLoad attr decorator_list ClassDef bases AttributeLoad NameLoad attr AttributeLoad NameLoad attr body Expr Str Pass decorator_list ClassDef bases NameLoad body Assign NameStore NameLoad FunctionDef arguments args NameParam defaults body Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr keyword ListLoad Str Assign NameStore Call NameLoad Assign TupleStore NameStore NameStore NameStore Call AttributeLoad SubscriptLoad AttributeLoad NameLoad attr Index Num attr Str Assign SubscriptStore NameLoad Index Str NameLoad Assign SubscriptStore NameLoad Index Str NameLoad Assign SubscriptStore NameLoad Index Str SubscriptLoad SubscriptLoad AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Index Str Index Num Assign NameStore BinOpMod Str SubscriptLoad NameLoad Index Str Assign NameStore Call AttributeLoad NameLoad attr keyword ListLoad NameLoad Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Str NameLoad NameLoad AugAssignAdd NameStore NameLoad Return ListLoad NameLoad NameLoad decorator_list decorator_list ClassDef bases NameLoad body Assign NameStore ListLoad Str Str Str Str FunctionDef arguments args NameParam NameParam defaults body Expr Str With Call NameLoad NameLoad Str NameStore body TryExcept body Assign NameStore Call AttributeLoad NameLoad attr NameLoad handlers ExceptHandler type AttributeLoad NameLoad attr name NameStore body Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Raise Assign NameStore Call AttributeLoad Str attr AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call NameLoad For NameStore NameLoad body For TupleStore NameStore NameStore Call AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr TupleLoad NameLoad SubscriptLoad NameLoad Index NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore AttributeLoad AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr attr Assign AttributeStore NameLoad attr AttributeLoad NameLoad attr If UnaryOpNot AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Str Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr Return ListLoad NameLoad If UnaryOpNot CompareGtE Call NameLoad AttributeLoad NameLoad attr Num body Expr Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Str Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr AttributeLoad NameLoad attr keyword AttributeLoad NameLoad attr Return ListLoad NameLoad Assign TupleStore NameStore NameStore Call AttributeLoad NameLoad attr Call AttributeLoad AttributeLoad NameLoad attr attr Expr Call AttributeLoad NameLoad attr NameLoad Assign AttributeStore NameLoad attr Call NameLoad AttributeLoad NameLoad attr Assign SubscriptStore AttributeLoad NameLoad attr Index Str TupleLoad Num Num Num Num Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr AttributeLoad NameLoad attr Assign TupleStore NameStore NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr NameLoad If NameLoad body Expr Call AttributeLoad NameLoad attr Num NameLoad Return BinOpAdd ListLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Assign NameStore ListLoad Assign NameStore ListLoad Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr keyword Call NameLoad NameLoad AugAssignAdd NameStore NameLoad AugAssignAdd NameStore NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Return TupleLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body FunctionDef arguments args NameParam defaults body Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call NameLoad Call AttributeLoad NameLoad attr Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Num NameLoad Return NameLoad decorator_list Assign NameStore ListLoad Assign NameStore ListLoad TryExcept body For TupleStore NameStore NameStore AttributeLoad NameLoad attr body Assign NameStore Call AttributeLoad NameLoad attr Str Str Assign NameStore Call AttributeLoad NameLoad attr Str Str Assign NameStore ListLoad If NameLoad body AugAssignAdd NameStore BinOpMod Str NameLoad Assign NameStore BinOpAdd Str Call AttributeLoad Call NameLoad NameLoad attr Str Str Expr Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad NameLoad attr keyword NameLoad Assign NameStore NameLoad If CompareIs Call AttributeLoad NameLoad attr Str NameLoad body AugAssignAdd NameStore Str AugAssignAdd NameStore Call NameLoad NameLoad AugAssignAdd NameStore Call NameLoad Call AttributeLoad NameLoad attr Str AugAssignAdd NameStore Call NameLoad Call AttributeLoad NameLoad attr Str AugAssignAdd NameStore Call NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad handlers ExceptHandler type NameLoad name NameStore body Expr Call AttributeLoad AttributeLoad NameLoad attr attr BinOpMod Str TupleLoad NameLoad NameLoad NameLoad Raise Return TupleLoad NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Assign NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr keyword Call NameLoad AttributeLoad NameLoad attr AugAssignAdd NameStore NameLoad Expr Call AttributeLoad NameLoad attr GeneratorExp Call AttributeLoad NameLoad attr keyword NameLoad keyword BinOpAdd Str Call NameLoad NameLoad comprehension TupleStore NameStore NameStore Call NameLoad AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr AugAssignAdd NameStore NameLoad Assign NameStore Call AttributeLoad NameLoad attr AugAssignAdd NameStore NameLoad Expr Call AttributeLoad NameLoad attr GeneratorExp Call AttributeLoad NameLoad attr NameLoad Call AttributeLoad NameLoad attr keyword NameLoad comprehension NameStore AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr AugAssignAdd NameStore NameLoad Assign TupleStore NameStore NameStore Call AttributeLoad NameLoad attr Expr Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list decorator_list FunctionDef arguments args NameParam NameParam defaults body Assign NameStore Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr BinOpMod NameLoad NameLoad Raise AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults body For NameStore Call AttributeLoad NameLoad attr body If Call NameLoad NameLoad NameLoad body Assign NameStore NameLoad Assign NameStore AttributeLoad NameLoad attr Assign NameStore AttributeLoad NameLoad attr Assign NameStore AttributeLoad NameLoad attr Expr Call AttributeLoad SubscriptLoad AttributeLoad NameLoad attr Index Str attr Str Expr Call AttributeLoad SubscriptLoad AttributeLoad NameLoad attr Index Str attr Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr Num Assign SubscriptStore NameLoad Index Str SubscriptLoad AttributeLoad NameLoad attr Index Num Assign SubscriptStore SubscriptLoad AttributeLoad NameLoad attr Index Str Index Num BinOpMod Str SubscriptLoad SubscriptLoad AttributeLoad NameLoad attr Index Str Index Num Assign SubscriptStore SubscriptLoad AttributeLoad NameLoad attr Index Str Index Num SubscriptLoad NameLoad Index Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Expr Call AttributeLoad NameLoad attr NameLoad NameLoad decorator_list FunctionDef arguments args NameParam defaults body Expr Call AttributeLoad NameLoad attr NameLoad keyword TupleLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str NameLoad Expr Call AttributeLoad NameLoad attr Str Expr Call AttributeLoad NameLoad attr Str Expr Call AttributeLoad NameLoad attr Str Expr Call AttributeLoad NameLoad attr Str Expr Call AttributeLoad NameLoad attr Str NameLoad Return Dict Str Str decorator_list
N/A N/A This provides a sphinx extension able to create the HTML needed
for the api-ref website.

It contains 2 new stanzas.

  .. rest_method:: GET /foo/bar

Which is designed to be used as the first stanza in a new section to
state that section is about that REST method. During processing the
rest stanza will be reparented to be before the section in question,
and used as a show/hide selector for it's details.

  .. rest_parameters:: file.yaml

     - name1: name_in_file1
     - name2: name_in_file2
     - name3: name_in_file3

Which is designed to build structured tables for either response or
request parameters. The stanza takes a value which is a file to lookup
details about the parameters in question.

The contents of the stanza are a yaml list of key / value pairs. The
key is the name of the parameter to be shown in the table. The value
is the key in the file.yaml where all other metadata about the
parameter will be extracted. This allows for reusing parameter
definitions widely in API definitions, but still providing for control
in both naming and ordering of parameters at every declaration.

 docutils nodes docutils.parsers.rst.directives.tables Table docutils.statemachine ViewList sphinx.util.compat Directive N/A yaml full_name N/A N/A cls N/A N/A N/A N/A N/A N/A cls __module__ . N/A cls __name__ N/A rest_method N/A N/A nodes Part N/A nodes Element N/A N/A rest_method custom node type

    We specify a custom node type for rest_method so that we can
    accumulate all the data about the rest method, but not render as
    part of the normal rendering process. This means that we need a
    renderer for every format we wish to support with this.

     N/A N/A RestMethodDirective N/A Directive N/A N/A has_content True run N/A N/A self N/A N/A N/A lineno N/A N/A N/A self state_machine abs_line_number N/A target N/A N/A nodes target N/A section N/A N/A nodes section classes N/A detail-control N/A node N/A rest_method N/A N/A method sep url N/A N/A N/A N/A self content N/A 0 partition N/A N/A node N/A method method N/A N/A node N/A url url N/A N/A node N/A target N/A N/A N/A N/A N/A self state parent attributes N/A ids N/A 0 N/A temp_target N/A %s-selector N/A node N/A target N/A target N/A N/A nodes target ids N/A temp_target N/A N/A N/A N/A self state add_target temp_target target lineno N/A section node N/A N/A target section N/A N/A RestParametersDirective N/A Table N/A N/A headers N/A Name In Type Description yaml_from_file N/A N/A self fpath N/A N/A N/A Collect Parameter stanzas from inline + file.

        This allows use to reference an external file for the actual
        parameter definitions.
         N/A N/A open fpath r stream N/A N/A N/A N/A lookup N/A N/A yaml load stream N/A N/A N/A N/A yaml YAMLError N/A exc N/A N/A N/A N/A N/A self app warn exc N/A N/A content N/A N/A join N/A self content N/A parsed N/A N/A yaml load content N/A new_content N/A list N/A paramlist parsed N/A N/A N/A name ref N/A N/A paramlist items N/A N/A N/A N/A new_content append N/A name N/A lookup N/A ref N/A N/A self yaml new_content N/A run N/A N/A self N/A N/A N/A env N/A N/A N/A N/A self state document settings env N/A N/A self app N/A env app N/A N/A N/A self content N/A N/A error N/A N/A N/A N/A self state_machine reporter error No parameters defined N/A N/A nodes literal_block N/A self block_text N/A self block_text line N/A self lineno N/A N/A error N/A N/A N/A N/A len N/A self arguments 1 N/A N/A N/A N/A N/A N/A self state_machine reporter error No reference file defined N/A N/A nodes literal_block N/A self block_text N/A self block_text line N/A self lineno N/A N/A error N/A N/A rel_fpath fpath N/A N/A env relfn2path N/A N/A N/A self arguments pop N/A N/A N/A self yaml_from_file fpath N/A N/A self max_cols N/A len N/A self headers N/A N/A N/A self options N/A widths N/A 20 10 10 60 N/A N/A self col_widths N/A N/A self get_column_widths N/A self max_cols N/A N/A title messages N/A N/A self make_title N/A table_node N/A N/A self build_table N/A N/A N/A self add_name table_node N/A title N/A N/A N/A N/A table_node insert 0 title N/A N/A N/A table_node messages N/A get_rows N/A N/A self table_data N/A N/A N/A rows N/A N/A groups N/A N/A trow N/A N/A nodes row N/A entry N/A N/A nodes entry N/A para N/A N/A nodes paragraph text N/A unicode table_data N/A entry para N/A trow entry N/A N/A N/A rows append trow N/A N/A rows groups N/A collect_rows N/A N/A self N/A N/A add_col N/A N/A value N/A N/A N/A entry N/A N/A nodes entry N/A result N/A ViewList N/A N/A value split N/A N/A N/A N/A self state nested_parse result 0 entry N/A entry N/A N/A rows N/A N/A groups N/A N/A N/A N/A N/A key values N/A self yaml N/A N/A min_version N/A N/A values get min_version N/A desc N/A N/A values get description N/A classes N/A N/A min_version N/A N/A desc N/A 

**New in version %s**
 min_version N/A min_ver_css_name N/A rp_min_ver_ N/A N/A N/A str min_version replace . _ N/A N/A N/A classes append min_ver_css_name N/A trow N/A N/A nodes row classes classes N/A name key N/A N/A N/A N/A values get optional True N/A N/A name  (Optional) N/A trow N/A add_col name N/A trow N/A add_col N/A N/A values get in N/A trow N/A add_col N/A N/A values get type N/A trow N/A add_col desc N/A N/A N/A rows append trow N/A N/A N/A AttributeError N/A exc N/A N/A N/A N/A N/A self app warn N/A Failure on key: %s, values: %s. %s N/A key values exc N/A N/A N/A rows groups N/A build_table N/A N/A self N/A N/A N/A table N/A N/A nodes table N/A tgroup N/A N/A nodes tgroup cols N/A len N/A self headers N/A table tgroup N/A N/A N/A tgroup extend N/A N/A N/A nodes colspec colwidth col_width colname N/A c N/A str idx N/A N/A idx col_width N/A enumerate N/A self col_widths N/A thead N/A N/A nodes thead N/A tgroup thead N/A row_node N/A N/A nodes row N/A thead row_node N/A N/A N/A row_node extend N/A N/A N/A nodes entry h N/A N/A nodes paragraph text h N/A h N/A self headers N/A tbody N/A N/A nodes tbody N/A tgroup tbody N/A N/A rows groups N/A N/A self collect_rows N/A N/A N/A tbody extend rows N/A N/A N/A table extend groups N/A table N/A N/A rest_method_html N/A N/A self node N/A N/A N/A tmpl 
<div class="row operation-grp">
    <div class="col-md-1 operation">
    <a name="%(target)s" class="operation-anchor" href="#%(target)s">
      <span class="glyphicon glyphicon-link"></span></a>
    <span class="label label-success">%(method)s</span>
    </div>
    <div class="col-md-5">%(url)s</div>
    <div class="col-md-5">%(desc)s</div>
    <div class="col-md-1">
    <button
       class="btn btn-info btn-sm btn-detail"
       data-target="#%(target)s-detail"
       data-toggle="collapse"
       id="%(target)s-detail-btn"
       >detail</button>
    </div>
</div> N/A N/A N/A N/A self body append N/A tmpl node N/A N/A nodes SkipNode N/A resolve_rest_references N/A N/A app doctree N/A N/A N/A node N/A N/A doctree traverse N/A N/A N/A isinstance node rest_method N/A N/A rest_node node N/A rest_method_section N/A node parent N/A rest_section N/A rest_method_section parent N/A gp N/A rest_section parent N/A N/A N/A N/A N/A rest_section attributes N/A classes append api-detail N/A N/A N/A N/A N/A rest_section attributes N/A classes append collapse N/A title N/A N/A N/A rest_section children pop 0 N/A N/A rest_node N/A desc N/A N/A title children N/A 0 N/A N/A N/A N/A rest_section attributes N/A ids N/A 0 N/A %s-detail N/A N/A N/A rest_section attributes N/A ids N/A 0 N/A N/A N/A N/A rest_method_section attributes N/A ids N/A 0 N/A rest_node N/A target N/A idx N/A N/A N/A gp children index rest_section N/A N/A N/A rest_section remove rest_method_section N/A N/A N/A gp insert idx rest_method_section N/A setup N/A N/A app N/A N/A N/A N/A N/A app add_node rest_method html N/A rest_method_html None N/A N/A N/A app add_directive rest_parameters RestParametersDirective N/A N/A N/A app add_directive rest_method RestMethodDirective N/A N/A N/A app add_stylesheet bootstrap.min.css N/A N/A N/A app add_stylesheet api-site.css N/A N/A N/A app add_javascript bootstrap.min.js N/A N/A N/A app add_javascript api-site.js N/A N/A N/A app connect doctree-read resolve_rest_references N/A N/A version 0.1 N/A