-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[DOCS] Adds compatibility matrix to docs and readme #2458
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
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
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! Should we also update https://github.com/elastic/elasticsearch-py/blob/main/docs/sphinx/index.rst#compatibility?
Co-authored-by: Quentin Pradet <[email protected]>
Yes, definitely! Thank you for the heads-up! I updated via 625c6fb. |
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.
The tables do not render correctly in reST:
- Read the Docs: https://elasticsearch-py--2458.org.readthedocs.build/en/2458/#compatibility
- GitHub: https://github.com/elastic/elasticsearch-py/blob/625c6fb3c0f676241d27f4f84b766fa2d152b127/README.rst
According to https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#tables, you're missing the separation between the lines (+---+---+---+
).
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.
Also, can you please change the casing as below? elasticsearch-py
isn't capitalized. Thanks and sorry for all the nitpicks.
Co-authored-by: Quentin Pradet <[email protected]>
…arch-py into szabosteve/comp-matrix
Thanks for all the work on this, @pquentin! BTW, tables are killing me. |
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 iterating! LGTM.
Co-authored-by: Quentin Pradet <[email protected]> (cherry picked from commit 44c5c69)
Co-authored-by: Quentin Pradet <[email protected]> (cherry picked from commit 44c5c69)
Co-authored-by: Quentin Pradet <[email protected]> (cherry picked from commit 44c5c69) Co-authored-by: István Zoltán Szabó <[email protected]>
Co-authored-by: Quentin Pradet <[email protected]> (cherry picked from commit 44c5c69) Co-authored-by: István Zoltán Szabó <[email protected]>
Co-authored-by: Quentin Pradet <[email protected]>
Overview
This PR adds a compatibility matrix to the Overview section of the Python book and the repo readme. It also fixes the markup of the links at the top of the Installation page.
Preview