Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: build and deploy docs. #575

Merged
merged 2 commits into from
Nov 11, 2023

Conversation

dblock
Copy link
Member

@dblock dblock commented Nov 10, 2023

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 Fix: typo, missing space. opensearch-api-specification#165 was merged.

Issues Resolved

Closes #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.

Copy link

codecov bot commented Nov 10, 2023

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% <ø> (ø)

Signed-off-by: dblock <dblock@amazon.com>
Signed-off-by: dblock <dblock@amazon.com>
@VachaShah VachaShah merged commit f410e81 into opensearch-project:main Nov 11, 2023
62 checks passed
@dblock dblock deleted the fix-build-deploy-docs branch November 13, 2023 13:30
roma2023 pushed a commit to roma2023/opensearch-py that referenced this pull request Dec 28, 2023
* Fix: build and deploy docs.

Signed-off-by: dblock <dblock@amazon.com>

* Run nox -rs generate.

Signed-off-by: dblock <dblock@amazon.com>

---------

Signed-off-by: dblock <dblock@amazon.com>
Signed-off-by: roma2023 <romasaparhan19@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] API documentation seems to be empty
2 participants