d3v3l0 / aws-cpp-developer-guide

Content for the AWS SDK for C++ Developer Guide. For more info about the AWS C++ SDK, go to http://github.com/aws/aws-sdk-cpp

aws-cpp-developer-guide

This repository contains the source text files for the AWS SDK for C++ Developer Guide.

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

Reporting issues

To report a problem in the guide, use the Issues section of the repository.

When submitting an issue, please indicate:

• The URL or source filename where the issue occurs.
• A detailed description of the issue.

Contributing fixes and updates

To contribute a fix or update to the guide, follow the standard Github procedures for forking the repository and submitting a pull request.

Be aware that many common substitutions and extlinks in the guide are defined in the shared content repository. If you see a text substitution that is not defined at either the top of the source file or in the doc_source/_includes.txt file, then it is probably located in the shared content.

Building the guide

When contributing to the guide, rebuild the guide and review the changes before submitting a pull request.

To build the guide:

1. Install the Python Sphinx package.
2. In the repository's root directory, run the Python build_docs.py script.

build_docs.py accepts arguments of any of the available Sphinx builders. For example, to build the guide in HTML format, use the html argument:

python build_docs.py html

The build process automatically downloads the contents of the shared content repository. The final generated files are written to the doc_output directory.

Code examples in the documentation

The code examples featured in the guide are located in a separate repository: aws-doc-sdk-examples. Full code and build files are included, so you can build and run any example yourself.

In addition to examples in C++, the repository includes examples in the other programming languages supported by the AWS SDKs. If you discover an issue with any example, submit an issue or fork the repository and submit a pull request.

The code examples are provided under the Apache 2.0 open source license. See the example repository's README for details.

Copyright and license

Unless otherwise stated, all content in this repository is Copyright © 2010-2019, 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.