Data Structures
class	AutoTornadoDirective

Functions
def	translate_tornado_rule (app, rule)

def	get_routes (app)

def	normalize_path (path)

def	setup (app)

Detailed Description

    sphinxcontrib.autohttp.tornado
    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    The sphinx.ext.autodoc-style HTTP API reference builder (from Tornado)
    for sphinxcontrib.httpdomain.

    :copyright: Copyright 2013 by Rodrigo Machado
    :license: BSD, see LICENSE for details.

Function Documentation

◆ translate_tornado_rule()

def httpdomain.autohttp.tornado.translate_tornado_rule	(	app,
		rule
	)

Definition at line 31 of file tornado.py.

def translate_tornado_rule(app, rule):
    buf = six.StringIO()
    for name, filter, conf in app.router.parse_rule(rule):
        if filter:
            buf.write('(')
            buf.write(name)
            if filter != app.router.default_filter or conf:
                buf.write(':')
                buf.write(filter)
            if conf:
                buf.write(':')
                buf.write(conf)
            buf.write(')')
        else:
            buf.write(name)
    return buf.getvalue()
 
 

◆ get_routes()

def httpdomain.autohttp.tornado.get_routes ( app )

Definition at line 49 of file tornado.py.

def get_routes(app):
    for spec in app.handlers[0][1]:
        handler = spec.handler_class
        doc_methods = list(handler.SUPPORTED_METHODS)
        if 'HEAD' in doc_methods:
            doc_methods.remove('HEAD')
        if 'OPTIONS' in doc_methods:
            doc_methods.remove('OPTIONS')
 
        for method in doc_methods:
            maybe_method = getattr(handler, method.lower(), None)
            if (inspect.isfunction(maybe_method) or
                    inspect.ismethod(maybe_method)):
                yield method.lower(), spec.regex.pattern, handler
 
 

References list.

Referenced by httpdomain.autohttp.tornado.AutoTornadoDirective.make_rst().

Here is the caller graph for this function:

◆ normalize_path()

def httpdomain.autohttp.tornado.normalize_path ( path )

Definition at line 65 of file tornado.py.

def normalize_path(path):
    if path.endswith('$'):
        path = path[:-1]
    return path
 
 

Referenced by httpdomain.autohttp.tornado.AutoTornadoDirective.make_rst().

Here is the caller graph for this function:

◆ setup()

def httpdomain.autohttp.tornado.setup ( app )

Definition at line 125 of file tornado.py.

def setup(app):
    if 'http' not in app.domains:
        httpdomain.setup(app)
    app.add_directive('autotornado', AutoTornadoDirective)