def _add_sub_resources(self, section):
section = section.add_new_section('sub-resources')
sub_resources = self._resource.meta.resource_model.subresources
if sub_resources:
documenter = SubResourceDocumenter(self._resource)
documenter.member_map = self.member_map
documenter.document_sub_resources(section)
def _add_sub_resources(self, section):
section = section.add_new_section('sub-resources')
sub_resources = self._resource.meta.resource_model.subresources
if sub_resources:
documenter = SubResourceDocumenter(self._resource)
documenter.member_map = self.member_map
documenter.document_sub_resources(section)
def test_document_sub_resources(self):
sub_resource_documentor = SubResourceDocumenter(self.resource)
sub_resource_documentor.document_sub_resources(self.doc_structure)
self.assert_contains_lines_in_order([
'.. py:method:: Sample(name)',
' Creates a Sample resource.::',
" sample = myservice.Sample('name')",
' :type name: string',
" :param name: The Sample's name identifier.",
' :rtype: :py:class:`MyService.Sample`',
' :returns: A Sample resource',
])
def test_document_sub_resources(self):
sub_resource_documentor = SubResourceDocumenter(self.resource)
sub_resource_documentor.document_sub_resources(self.doc_structure)
self.assert_contains_lines_in_order([
'.. py:method:: Sample(name)',
' Creates a Sample resource.::',
" sample = myservice.Sample('name')",
' :type name: string',
" :param name: The Sample's name identifier.",
' :rtype: :py:class:`MyService.Sample`',
' :returns: A Sample resource',
])
