def test_description_only_for_crosslink_manpage(self): help_command = self.create_help_command() operation_handler = OperationDocumentEventHandler(help_command) operation_handler.doc_description(help_command=help_command) rendered = help_command.doc.getvalue().decode('utf-8') # The links are generated in the "man" mode. self.assertIn('See also: AWS API Documentation', rendered)
def test_includes_global_args_ref_in_man_description(self): help_command = self.create_help_command() operation_handler = OperationDocumentEventHandler(help_command) operation_handler.doc_description(help_command=help_command) rendered = help_command.doc.getvalue().decode('utf-8') # The links aren't generated in the "man" mode. self.assertIn("See 'aws help' for descriptions of global parameters", rendered)
def test_includes_global_args_ref_in_html_description(self): help_command = self.create_help_command() help_command.doc.target = 'html' operation_handler = OperationDocumentEventHandler(help_command) operation_handler.doc_description(help_command=help_command) rendered = help_command.doc.getvalue().decode('utf-8') self.assertIn( "See :doc:`'aws help' </reference/index>` for descriptions of " "global parameters", rendered)
def test_includes_global_args_ref_in_man_description(self): help_command = self.create_help_command() operation_handler = OperationDocumentEventHandler(help_command) operation_handler.doc_description(help_command=help_command) rendered = help_command.doc.getvalue().decode('utf-8') # The links aren't generated in the "man" mode. self.assertIn( "See 'aws help' for descriptions of global parameters", rendered )
def test_includes_global_args_ref_in_html_description(self): help_command = self.create_help_command() help_command.doc.target = 'html' operation_handler = OperationDocumentEventHandler(help_command) operation_handler.doc_description(help_command=help_command) rendered = help_command.doc.getvalue().decode('utf-8') self.assertIn( "See :doc:`'aws help' </reference/index>` for descriptions of " "global parameters", rendered )
def test_includes_webapi_crosslink_in_html(self): help_command = self.create_help_command() # Configure this for 'html' generation: help_command.obj.service_model.metadata = {'uid': 'service-1-2-3'} help_command.obj.name = 'myoperation' help_command.doc.target = 'html' operation_handler = OperationDocumentEventHandler(help_command) operation_handler.doc_description(help_command=help_command) rendered = help_command.doc.getvalue().decode('utf-8') # Should expect an externa link because we're generating html. self.assertIn( 'See also: `AWS API Documentation ' '<https://docs.aws.amazon.com/goto/' 'WebAPI/service-1-2-3/myoperation>`_', rendered)