Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Solution
Fixed the links and format per warnings
These warnings remain:
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
Documentation
Title and description
Fixes #xxx
- N/ABy submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license.