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.

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

documentation: Get Read the Docs working #46

Merged
merged 5 commits into from
Aug 14, 2020
Merged

documentation: Get Read the Docs working #46

merged 5 commits into from
Aug 14, 2020

Conversation

speller26
Copy link
Member

Issue #, if available:

Description of changes:

Fixed previously failing Read the Docs builds by:

  1. Explicity adding method and path to .readthedocs.yml; this was causing builds to fail altogether
  2. Using sphinxcontrib-apidoc instead autodoc directly (see Support auto-generated API docs readthedocs/readthedocs.org#1139). Defore, our tox -e docs command would run aphinx-apidoc then sphinx-build. However, Read the Docs only runs sphinx-build, so the module docs would never get generated.

Testing done:

build_files.tar.gz

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

Tests

  • I have added tests that prove my fix is effective or that my feature works (if appropriate)
  • I have checked that my tests are not configured for a specific region or account (if appropriate)

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@speller26 speller26 requested a review from avawang1 August 14, 2020 21:26
@speller26 speller26 requested a review from floralph as a code owner August 14, 2020 21:26
@amazon-braket-ci-bot
Copy link
Contributor

AWS CodeBuild CI Report

  • CodeBuild project: DefaultSimulatorPullRequestBuild
  • Commit ID: 58be508
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@speller26 speller26 merged commit 0d80a54 into main Aug 14, 2020
@speller26 speller26 deleted the feature/docz branch August 14, 2020 21:30
speller26 added a commit to amazon-braket/amazon-braket-schemas-python that referenced this pull request Aug 14, 2020
speller26 added a commit to amazon-braket/amazon-braket-ocean-plugin-python that referenced this pull request Aug 14, 2020
speller26 added a commit to amazon-braket/amazon-braket-sdk-python that referenced this pull request Aug 14, 2020
speller26 added a commit to amazon-braket/amazon-braket-ocean-plugin-python that referenced this pull request Aug 14, 2020
speller26 added a commit to amazon-braket/amazon-braket-sdk-python that referenced this pull request Aug 14, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants