Documents an entire service. :returns: The reStructured text of the documented service.
(self)
| 47 | ] |
| 48 | |
| 49 | def document_service(self): |
| 50 | """Documents an entire service. |
| 51 | |
| 52 | :returns: The reStructured text of the documented service. |
| 53 | """ |
| 54 | doc_structure = DocumentStructure( |
| 55 | self._service_name, section_names=self.sections, target='html' |
| 56 | ) |
| 57 | self.title(doc_structure.get_section('title')) |
| 58 | self.table_of_contents(doc_structure.get_section('table-of-contents')) |
| 59 | self.client_api(doc_structure.get_section('client-api')) |
| 60 | self.client_exceptions(doc_structure.get_section('client-exceptions')) |
| 61 | self.paginator_api(doc_structure.get_section('paginator-api')) |
| 62 | self.waiter_api(doc_structure.get_section('waiter-api')) |
| 63 | context_params_section = doc_structure.get_section( |
| 64 | 'client-context-params' |
| 65 | ) |
| 66 | self.client_context_params(context_params_section) |
| 67 | return doc_structure.flush_structure() |
| 68 | |
| 69 | def title(self, section): |
| 70 | section.style.h1(self._client.__class__.__name__) |