-
Notifications
You must be signed in to change notification settings - Fork 179
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
DOC: Clear warnings when building docs #2134
DOC: Clear warnings when building docs #2134
Conversation
I'm going to step back from reviewing this one because I don't have a good handle on the docs. Sorry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for fixing the warnings!
Please take a look at the comments below.
Co-authored-by: Victoriya Fedotova <viktoria.nn@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's get green CI and merge.
4a5c5c1
to
86d1cad
Compare
Description
This doc clears some warnings thrown by sphinx when building the documentation for sklearnex.
The following warnings should now disappear:
Note: here I'm switching Sphinx option
display_version
toversion_selector
, as suggested in their docs:https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-display_version
If I understand the docs correctly, this
display_version
option shouldn't actually be doing anything when building with the version of Sphinx in the locked requirements, but they mention that this option requires the ReadTheDocs add-on, which I don't know if is used by the CI job that builds the docs:https://sphinx-rtd-theme.readthedocs.io/en/stable/configuring.html#confval-version_selector
Checklist to comply with before moving PR from draft:
PR completeness and readability
Testing
Performance
Not applicable