fixing documentation issue #20
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Dhrubo Saha <dhrubo@amazon.com>
ylwu-amzn
reviewed
Nov 3, 2022
| bash $script_path/run-${RUNSCRIPT}.sh | ||
| done | ||
| fi | ||
| #if [[ -n "$RUNSCRIPTS" ]]; then |
There was a problem hiding this comment.
Wha's this part for? Why comment out this part?
If don't need this in future, we can remove it.
There was a problem hiding this comment.
Yeah I was testing if It requires anywhere. I'll remove this in the next PR.
ylwu-amzn
approved these changes
Nov 3, 2022
Zhangxunmt
approved these changes
Nov 3, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Signed-off-by: Dhrubo Saha dhrubo@amazon.com
Description
For document generation, sphinx creates a build folder where all the html files are stored. For opensearch-py-ml, it's tricky to build docs in github. for opensearch-py-ml, Building docs requires opensearch connection and in github we establish connection using docker. But in docker if we build docs, docs will be generated inside docker. For this reason, we need to take out those documents and then put in the github to deploy the doc.
Issues Resolved
[List any issues this PR will resolve]
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.