Module Contents

class SubResourceDocumenter

document_sub_resources(self, section)
document_sub_resource(section, resource_name, sub_resource_model, service_model, include_signature=True)

Documents a resource action

  • section – The section to write to
  • resource_name – The name of the resource
  • sub_resource_model – The model of the subresource
  • service_model – The model of the service
  • include_signature – Whether or not to include the signature. It is useful for generating docstrings.