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

Avoid multiple WorkerState sphinx error #8643

Merged
merged 1 commit into from May 20, 2024
Merged

Conversation

jrbourbeau
Copy link
Member

Currently our docs build is failing with

/home/docs/checkouts/readthedocs.org/user_builds/distributed/envs/8638/lib/python3.11/site-packages/distributed/diagnostics/plugin.py:docstring of 
distributed.diagnostics.plugin.SchedulerPlugin.valid_workers_downscaling:: WARNING: more than
one target found for cross-reference 'WorkerState': distributed.scheduler.WorkerState, distributed.worker_state_machine.WorkerState

This PR avoid that error by using the same workaround as

# Needed to avoid Sphinx WARNING: more than one target found for cross-reference
# 'TaskState' and 'WorkerState'"
# https://github.com/agronholm/sphinx-autodoc-typehints#dealing-with-circular-imports
from distributed import client
from distributed import scheduler as scheduler_module

Copy link
Contributor

github-actions bot commented May 7, 2024

Unit Test Results

See test report for an extended history of previous test failures. This is useful for diagnosing flaky tests.

    29 files  ±0      29 suites  ±0   10h 58m 20s ⏱️ - 1m 49s
 4 051 tests ±0   3 947 ✅  - 2     97 💤 ±0  7 ❌ +2 
55 799 runs  ±0  53 631 ✅  - 2  2 159 💤  - 1  9 ❌ +3 

For more details on these failures, see this check.

Results for commit 037176e. ± Comparison against base commit d5edb4e.

@jrbourbeau
Copy link
Member Author

I'm going to merge this one in to get our docs build passing again. Happy to address any comments in a follow-up PR.

@jrbourbeau jrbourbeau merged commit e036757 into dask:main May 20, 2024
27 of 37 checks passed
@jrbourbeau jrbourbeau deleted the doc-fixup branch May 20, 2024 15:42
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.

None yet

1 participant