opensearch-project / opensearch-py

Python Client for OpenSearch
https://opensearch.org/docs/latest/clients/python/
Apache License 2.0
338 stars 170 forks source link

Fix: build and deploy docs. #575

Closed dblock closed 10 months ago

dblock commented 10 months ago

Description

Imports in https://github.com/opensearch-project/opensearch-py/actions/runs/6828368821/job/18572361261 are silently failing with this:

WARNING: autodoc: failed to import class 'client.cat.CatClient' from module 'opensearchpy'; the following exception was raised:
No module named 'aiohttp'
  1. Added aiohttp to the docs requires.
  2. Turned on warnings as errors so we can catch these, and running docs in PRs in the same workflow as the site deployment.
  3. Use nox -rs docs everywhere.
  4. Ran nox -rs generate with https://github.com/opensearch-project/opensearch-api-specification/pull/165 was merged.

Issues Resolved

Closes https://github.com/opensearch-project/opensearch-py/issues/558.

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.

codecov[bot] commented 10 months ago

Codecov Report

Merging #575 (a058df0) into main (f1d0237) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #575   +/-   ##
=======================================
  Coverage   71.70%   71.70%           
=======================================
  Files          87       87           
  Lines        7886     7886           
=======================================
  Hits         5655     5655           
  Misses       2231     2231           
Files Coverage Δ
opensearchpy/_async/client/__init__.py 45.78% <ø> (ø)
opensearchpy/client/__init__.py 61.17% <ø> (ø)