boto3.docs

Package Contents

class ServiceDocumenter(service_name, session)

Bases:botocore.docs.service.ServiceDocumenter

EXAMPLE_PATH
document_service(self)

Documents an entire service.

Returns:The reStructured text of the documented service.
client_api(self, section)
_document_service_resource(self, section)
_document_resources(self, section)
_get_example_file(self)
_document_examples(self, section)
generate_docs(root_dir, session)

Generates the reference documentation for botocore

This will go through every available AWS service and output ReSTructured text files documenting each service.

Parameters:
  • root_dir – The directory to write the reference files to. Each service’s reference documentation is loacated at root_dir/reference/services/service-name.rst
  • session – The boto3 session