Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fail loudly and immediately if we can't gen docs #569

Merged
merged 2 commits into from
Dec 20, 2013
Merged

Fail loudly and immediately if we can't gen docs #569

merged 2 commits into from
Dec 20, 2013

Commits on Dec 20, 2013

  1. Fail loudly and immediately if we can't gen docs 

    If htmlgen fails, the whole process fails immediately and you get
a non zero RC.  Previously it would just move on to the rendering
step, which makes it harder to notice build errors.

You now get:

  ...rds
  ...redshift
  ...route53
  ...s3
  ...s3api
  Traceback (most recent call last):
    File "aws-cli/doc/source/htmlgen", line 108, in <module>
      do_provider(driver)
    File "aws-cli/doc/source/htmlgen", line 66, in do_provider
      do_service(driver, REF_PATH, service_name, service_command)
    File "aws-cli/doc/source/htmlgen", line 48, in do_service
      help_command(None, None)
    File "aws-cli/awscli/help.py", line 232, in __call__
      bcdoc.docevents.generate_events(self.session, self)
    File "bcdoc/docevents.py", line 50, in generate_events
      help_command.name, help_command=help_command)
    File "bcdoc/docevents.py", line 36, in fire_event
      session.emit(event, **kwargs)
    File "botocore/botocore/session.py", line 551, in emit
      return self._events.emit(event_name, **kwargs)
    File "botocore/botocore/hooks.py", line 158, in emit
      response = handler(**kwargs)
    File "aws-cli/awscli/clidocs.py", line 243, in doc_description
      doc.include_doc_string(service.documentation)
  AttributeError: 'Service' object has no attribute 'documentation'
  Failed to generate documetation!
  make: *** [html] Error 2

  $ echo $?
  2
    @jamesls
    jamesls committed Dec 20, 2013
    Configuration menu
    Copy the full SHA
    a74879c View commit details
    Browse the repository at this point in the history

  2. Spell documentation properly

    @jamesls
    jamesls committed Dec 20, 2013
    Configuration menu
    Copy the full SHA
    a9c5d41 View commit details
    Browse the repository at this point in the history