in awscli/bcdoc/docevents.py [0:0]
def generate_events(session, help_command):
# Now generate the documentation events
session.emit('doc-breadcrumbs.%s' % help_command.event_class,
help_command=help_command)
session.emit('doc-title.%s' % help_command.event_class,
help_command=help_command)
session.emit('doc-description.%s' % help_command.event_class,
help_command=help_command)
session.emit('doc-synopsis-start.%s' % help_command.event_class,
help_command=help_command)
if help_command.arg_table:
for arg_name in help_command.arg_table:
# An argument can set an '_UNDOCUMENTED' attribute
# to True to indicate a parameter that exists
# but shouldn't be documented. This can be used
# for backwards compatibility of deprecated arguments.
if getattr(help_command.arg_table[arg_name],
'_UNDOCUMENTED', False):
continue
session.emit(
'doc-synopsis-option.%s.%s' % (help_command.event_class,
arg_name),
arg_name=arg_name, help_command=help_command)
session.emit('doc-synopsis-end.%s' % help_command.event_class,
help_command=help_command)
session.emit('doc-options-start.%s' % help_command.event_class,
help_command=help_command)
if help_command.arg_table:
for arg_name in help_command.arg_table:
if getattr(help_command.arg_table[arg_name],
'_UNDOCUMENTED', False):
continue
session.emit('doc-option.%s.%s' % (help_command.event_class,
arg_name),
arg_name=arg_name, help_command=help_command)
session.emit('doc-option-example.%s.%s' %
(help_command.event_class, arg_name),
arg_name=arg_name, help_command=help_command)
session.emit('doc-options-end.%s' % help_command.event_class,
help_command=help_command)
session.emit('doc-global-option.%s' % help_command.event_class,
help_command=help_command)
session.emit('doc-subitems-start.%s' % help_command.event_class,
help_command=help_command)
if help_command.command_table:
for command_name in sorted(help_command.command_table.keys()):
if hasattr(help_command.command_table[command_name],
'_UNDOCUMENTED'):
continue
session.emit('doc-subitem.%s.%s'
% (help_command.event_class, command_name),
command_name=command_name,
help_command=help_command)
session.emit('doc-subitems-end.%s' % help_command.event_class,
help_command=help_command)
session.emit('doc-examples.%s' % help_command.event_class,
help_command=help_command)
session.emit('doc-output.%s' % help_command.event_class,
help_command=help_command)
session.emit('doc-relateditems-start.%s' % help_command.event_class,
help_command=help_command)
if help_command.related_items:
for related_item in sorted(help_command.related_items):
session.emit('doc-relateditem.%s.%s'
% (help_command.event_class, related_item),
help_command=help_command,
related_item=related_item)
session.emit('doc-relateditems-end.%s' % help_command.event_class,
help_command=help_command)