Skip to content
This repository was archived by the owner on Jun 15, 2023. It is now read-only.

readme.rst

Latest commit

 

History

History
113 lines (75 loc) · 5.11 KB

readme.rst

File metadata and controls

113 lines (75 loc) · 5.11 KB

NOTICE

This repository is archived and the content on this branch is out of date. You can find up-to-date AWS technical documentation on the AWS Documentation website, where you can also submit feedback and suggestions for improvement.

Announcement

This repository will be archived and marked read-only next month (June 2023). For more information, read the announcement on the AWS News Blog.

You can find the corresponding content for this repo on the AWS Documentation website. If you'd like to continue contributing to the quality of AWS documentation, you can submit feedback and suggestions for improvement there.

aws-mobile-developer-guide

This repository contains source content for the official `AWS Mobile Developer Guide <https://docs.aws.amazon.com/aws-mobile/latest/developerguide/what-is-aws-mobile.html`_. The source code for the AWS Mobile SDKs is available at:

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

License Summary

The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file.

The sample code within this documentation is made available under a modified MIT license. See the LICENSE-SAMPLECODE file.