diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b7767643..392d96a8 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -52,3 +52,22 @@ jobs: - name: Check with Twine working-directory: dist run: twine check * + + test-docs-build: + runs-on: ubuntu-latest + steps: + - name: Checkout Repository + uses: actions/checkout@v3 + - name: Set up Python 3.7 + uses: actions/setup-python@v4 + with: + python-version: 3.7 + - name: Install dependencies + run: | + python -m pip install --upgrade pip + - name: Check if Sphinx docs are built + run: | + pip install -e .[docs] + cd docs + make html + diff --git a/CHANGELOG.md b/CHANGELOG.md index 00c54476..95b20f9a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -22,6 +22,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Removed tests against Python 2.7 in github workflows ([#421](https://github.com/opensearch-project/opensearch-py/pull/421)) ### Fixed - Fixed import cycle when importing async helpers ([#311](https://github.com/opensearch-project/opensearch-py/pull/311)) +- Fixed make docs with sphinx([#433](https://github.com/opensearch-project/opensearch-py/pull/433)) - Fixed userguide for async client ([#340](https://github.com/opensearch-project/opensearch-py/pull/340)) - Include parsed error info in TransportError in async connections (fixes #225) ([#226](https://github.com/opensearch-project/opensearch-py/pull/226)) - Enhanced existing API generator to use OpenSearch OpenAPI spec ([#412](https://github.com/opensearch-project/opensearch-py/pull/412)) diff --git a/docs/source/api-ref/serializer.md b/docs/source/api-ref/serializer.md index 4e9fd751..325e362c 100644 --- a/docs/source/api-ref/serializer.md +++ b/docs/source/api-ref/serializer.md @@ -4,6 +4,3 @@ .. autoclass:: opensearchpy.JSONSerializer ``` -```{eval-rst} -.. autoclass:: opensearchpy.AttrJSONSerializer -``` \ No newline at end of file