BUG FIX #538 (#760)

.github/workflows/.lychee.excludes

@@ -0,0 +1 @@
+file:///github/workspace/*

.github/workflows/links.yml

@@ -18,7 +18,8 @@ jobs:
         id: lychee
         uses: lycheeverse/[email protected]
         with:
-          args: --accept=200,403,429  "**/*.html" "**/*.md" "**/*.txt" "**/*.json" --exclude "file:///github/workspace/*" --exclude-mail
+          args: --accept=200,403,429 "**/*.html" "**/*.md" "**/*.txt" "**/*.json" --exclude-file ".github/workflows/.lychee.excludes" --exclude-mail 
           fail: true
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+      

CHANGELOG.md

@@ -258,6 +258,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 ### Fixed
 - Fixed DeprecationWarning emitted from urllib3 1.26.13+ ([#246](https://github.com/opensearch-project/opensearch-py/pull/246))
 - Fixed Wrong return type hint in `async_scan` ([520](https://github.com/opensearch-project/opensearch-py/pull/520))
+- Fixed link checker failing due to relative link ([#760](https://github.com/opensearch-project/opensearch-py/pull/760))
 ### Security
 
 [Unreleased]: https://github.com/opensearch-project/opensearch-py/compare/v2.6.0...HEAD

docs/source/README.md

@@ -1 +0,0 @@
-../../README.md

docs/source/index.md

@@ -16,6 +16,6 @@ Developer Guide <https://github.com/opensearch-project/opensearch-py/blob/main/D
 GitHub Repository <https://github.com/opensearch-project/opensearch-py>
 ```
 
-```{include} README.md
+```{include} ../../README.md
 
 ```