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

docs: Fix doc format and links #182

Merged
merged 1 commit into from
Nov 25, 2021
Merged

docs: Fix doc format and links #182

merged 1 commit into from
Nov 25, 2021

Conversation

ca-nguyen
Copy link
Contributor

Description

Fix docstring links and format

Fixes #(issue) - N/A

Why is the change necessary?

There are a few issues with certain docstrings links and format
Generating the documentation locally with sphynx returned the following warnings

/README.rst:: WARNING: image file not readable: doc/images/create.png
/README.rst:: WARNING: image file not readable: doc/images/execute.png
/src/stepfunctions/steps/sagemaker.py:docstring of stepfunctions.steps.sagemaker.TrainingStep:26: WARNING: Unexpected indentation.
/src/stepfunctions/steps/sagemaker.py:docstring of stepfunctions.steps.sagemaker.TrainingStep:27: WARNING: Block quote ends without a blank line; unexpected unindent.
/src/stepfunctions/steps/sagemaker.py:docstring of stepfunctions.steps.sagemaker.TrainingStep:39: WARNING: Unknown target name: "createtrainingjob<https://docs.aws.amazon.com/sagemaker/latest/apireference/api_createtrainingjob.html>".
/src/stepfunctions/steps/sagemaker.py:docstring of stepfunctions.steps.sagemaker.TrainingStep:39: WARNING: Unknown target name: "placeholders<https://aws-step-functions-data-science-sdk.readthedocs.io/en/stable/placeholders.html?highlight=placeholder#stepfunctions.inputs.placeholder>".
/src/stepfunctions/steps/sagemaker.py:docstring of stepfunctions.steps.sagemaker.TransformStep:39: WARNING: Unknown target name: "createtransformjob<https://docs.aws.amazon.com/sagemaker/latest/apireference/api_createtransformjob.html>".
/src/stepfunctions/steps/sagemaker.py:docstring of stepfunctions.steps.sagemaker.TransformStep:39: WARNING: Unknown target name: "placeholders<https://aws-step-functions-data-science-sdk.readthedocs.io/en/stable/placeholders.html?highlight=placeholder#stepfunctions.inputs.placeholder>".
/src/stepfunctions/steps/sagemaker.py:docstring of stepfunctions.steps.sagemaker.TuningStep:28: WARNING: Unknown target name: "createhyperparametertuningjob<https://docs.aws.amazon.com/sagemaker/latest/apireference/api_createhyperparametertuningjob.html>".
/src/stepfunctions/steps/sagemaker.py:docstring of stepfunctions.steps.sagemaker.TuningStep:28: WARNING: Unknown target name: "placeholders<https://aws-step-functions-data-science-sdk.readthedocs.io/en/stable/placeholders.html?highlight=placeholder#stepfunctions.inputs.placeholder>".
/src/stepfunctions/steps/sagemaker.py:docstring of stepfunctions.steps.sagemaker.ModelStep:13: WARNING: Unknown target name: "createmodel<https://docs.aws.amazon.com/sagemaker/latest/apireference/api_createmodel.html>".
/src/stepfunctions/steps/sagemaker.py:docstring of stepfunctions.steps.sagemaker.ModelStep:13: WARNING: Unknown target name: "placeholders<https://aws-step-functions-data-science-sdk.readthedocs.io/en/stable/placeholders.html?highlight=placeholder#stepfunctions.inputs.placeholder>".
/src/stepfunctions/steps/sagemaker.py:docstring of stepfunctions.steps.sagemaker.ProcessingStep:32: WARNING: Unknown target name: "createprocessingjob<https://docs.aws.amazon.com/sagemaker/latest/apireference/api_createprocessingjob.html>".
/src/stepfunctions/steps/sagemaker.py:docstring of stepfunctions.steps.sagemaker.ProcessingStep:32: WARNING: Unknown target name: "placeholders<https://aws-step-functions-data-science-sdk.readthedocs.io/en/stable/placeholders.html?highlight=placeholder#stepfunctions.inputs.placeholder>".
/doc/services.rst:73: WARNING: Title underline too short.

Amazon EventBridge
-----------
/aws-step-functions-data-science-sdk-python/doc/services.rst:73: WARNING: Title underline too short.

Amazon EventBridge
-----------
/src/stepfunctions/steps/service.py:docstring of stepfunctions.steps.service.StepFunctionsStartExecutionStep:7: WARNING: Unexpected indentation.
/src/stepfunctions/steps/service.py:docstring of stepfunctions.steps.service.StepFunctionsStartExecutionStep:1: WARNING: Unknown target name: "manage aws step functions executions as an integrated service <https://docs.aws.amazon.com/step-functions/latest/dg/connect-stepfunctions.html".
/src/stepfunctions/steps/service.py:docstring of stepfunctions.steps.service.StepFunctionsStartExecutionStep:7: WARNING: Unknown target name: "run a job <https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync".
/src/stepfunctions/steps/service.py:docstring of stepfunctions.steps.service.StepFunctionsStartExecutionStep:7: WARNING: Unknown target name: "wait for a callback with the task token <https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token".
/src/stepfunctions/steps/service.py:docstring of stepfunctions.steps.service.StepFunctionsStartExecutionStep:7: WARNING: Unknown target name: "request response <https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-default".

Solution

Fixed the links and format per warnings

These warnings remain:

/README.rst:: WARNING: image file not readable: doc/images/create.png
/README.rst:: WARNING: image file not readable: doc/images/execute.png

Validated that the rst file is rendered properly and that the images are readable - these warnings only apply when rendering using Sphynx

How was this missed?

These doc changes have not been validated by generating the documentation locally before being merged - created a PR to include this step in the PR checklist and to add instructions on how to generate the docs locally in the CONTRIBUTING guide

Testing

Generate the Sphynx docs locally to validate links and doc format


Pull Request Checklist

Please check all boxes (including N/A items)

Testing

  • Unit tests added - N/A
  • Integration test added - N/A
  • Manual testing - why was it necessary? could it be automated? - N/A

Documentation

  • docs: All relevant docs updated
  • docstrings: All public APIs documented

Title and description

  • Change type: Title is prefixed with change type: and follows conventional commits
  • References: Indicate issues fixed via: Fixes #xxx - N/A

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

@StepFunctions-Bot
Copy link
Contributor

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject6AEA49D1-sEHrOdk7acJc
  • Commit ID: cf22cd0
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

Copy link

@jormello jormello left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Going to look into whether we can fix the image warning.

@ca-nguyen ca-nguyen merged commit 72184a2 into aws:main Nov 25, 2021
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.

5 participants