-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
More docs fixes #3326
More docs fixes #3326
Conversation
f5a17d4
to
94a6e02
Compare
94a6e02
to
e66a350
Compare
Friendly ping. This resolves more classes of build warnings that are thrown during documentation builds (examples of remaining warnings that I'd like to resolve after this PR merges). 😀 |
…ings When Sphinx runs, `TYPE_CHECKING` is not enabled, so the differentiating sync/async `Redis` imports don't happen, and Sphinx appears to be unable to infer which class `"Redis"` should cross-reference.
e66a350
to
b30d689
Compare
Hello @gerzse and @vladvildanov! Please review this PR when you can. It addresses three categories of documentation build warnings. If this merges, there will only be one documentation warning category left: "reference target not found".
|
@kurtmckee Thank you for your contribution! |
* Docs: Resolve 'Unexpected indentation' warnings * Docs: Resolve 'Unexpected unindent' warnings * Docs: Resolve "more than one target for cross-reference 'Redis'" warnings When Sphinx runs, `TYPE_CHECKING` is not enabled, so the differentiating sync/async `Redis` imports don't happen, and Sphinx appears to be unable to infer which class `"Redis"` should cross-reference. --------- Co-authored-by: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com>
* Docs: Resolve 'Unexpected indentation' warnings * Docs: Resolve 'Unexpected unindent' warnings * Docs: Resolve "more than one target for cross-reference 'Redis'" warnings When Sphinx runs, `TYPE_CHECKING` is not enabled, so the differentiating sync/async `Redis` imports don't happen, and Sphinx appears to be unable to infer which class `"Redis"` should cross-reference. --------- Co-authored-by: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com>
* Docs: Resolve 'Unexpected indentation' warnings * Docs: Resolve 'Unexpected unindent' warnings * Docs: Resolve "more than one target for cross-reference 'Redis'" warnings When Sphinx runs, `TYPE_CHECKING` is not enabled, so the differentiating sync/async `Redis` imports don't happen, and Sphinx appears to be unable to infer which class `"Redis"` should cross-reference. --------- Co-authored-by: Vladyslav Vildanov <117659936+vladvildanov@users.noreply.github.com>
Pull Request check-list
Please make sure to review and check all of these items:
NOTE: these things are not required to open a PR and can be done
afterwards / while the PR is open.
Description of change
This PR resolves three classes of warnings and errors that Sphinx reports when building the documentation (recent example; click the
python -m sphinx
accordion to see the details):