Skip to content

Latest commit

 

History

History
95 lines (66 loc) · 4.45 KB

README.rst

File metadata and controls

95 lines (66 loc) · 4.45 KB
Raw

aws-ios-developer-guide

This repository contains source content for the official AWS SDK for iOS Developer Guide. The source code for the AWS SDK for iOS is also on GitHub, at https://github.com/aws/aws-sdk-ios.

The guide content is written in reStructuredText and built using Sphinx. It relies upon content which is provided in the AWS documentation team's shared content repository.

Reporting issues

You can use the Issues section of this repository to report problems in the documentation. When submitting an issue, please indicate:

  • what page (a URL or filename is best) the issue occurs on.
  • what the issue is, using as much detail as you can provide. For many issues, this might be as simple as "The page has a typo; the word 'complie' in the third paragraph shoud be 'compile'." If the issue is more complex, please describe it with enough detail that it's clear to the AWS documentation team what the problem is.

Contributing fixes and updates

To contribute your own documentation fixes or updates, please use the Github-standard procedures for forking the repository and submitting a pull request.

Note that many common substitutions and extlinks found in these docs are sourced from the shared content repository--if you see a substitution used that is not declared at the top of the source file or in the _includes.txt file, then it is probably defined in the shared content.

Building the documentation

If you are planning to contribute to the docs, you should build your changes and review them before submitting your pull request.

To build the docs:

  1. Make sure that you have downloaded and installed Sphinx.
  2. Run the build_docs.py script in the repository's root directory.

The build process will automatically download a snapshot of the shared content, combine it in the build directory and will generate output into the output directory.

build_docs.py can take any of the available Sphinx builders as its argument. For example, to build the docs into a single HTML page, you can use the htmlsingle target, like so:

python build_docs.py htmlsingle

Copyright and license

All content in this repository, unless otherwise stated, is Copyright © 2010-2016, Amazon Web Services, Inc. or its affiliates. All rights reserved.

Except where otherwise noted, this work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License (the "License"). Use the preceding link for a human-readable summary of the license terms. The full license text is available at: http://creativecommons.org/licenses/by-nc-sa/4.0/legalcode and in the LICENSE file accompanying this repository.