fix : remove AttrJSONSerializer from autodoc classes to document (#433)

* fix : remove AttrJSONSerializer from autodoc classes to document

Signed-off-by: naveen <naveenmathew0508@gmail.com>

* Update CHANGELOG.md

Signed-off-by: naveen <naveenmathew0508@gmail.com>

* ci: check if docs are built successfully

Signed-off-by: naveen <naveenmathew0508@gmail.com>

---------

Signed-off-by: naveen <naveenmathew0508@gmail.com>
This commit is contained in:
Naveen Mathew
2023-07-13 22:52:30 +05:30
committed by GitHub
parent 2003156d9e
commit faa298a3c4
3 changed files with 20 additions and 3 deletions
+19
View File
@@ -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
+1
View File
@@ -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))
-3
View File
@@ -4,6 +4,3 @@
.. autoclass:: opensearchpy.JSONSerializer
```
```{eval-rst}
.. autoclass:: opensearchpy.AttrJSONSerializer
```