Resolve Sphinx Documentation Build Errors in presto-native.rst#22311
Resolve Sphinx Documentation Build Errors in presto-native.rst#22311Akanksha-kedia wants to merge 1 commit intoprestodb:masterfrom
Conversation
|
Codenotify: Notifying subscribers in CODENOTIFY files for diff 48c5a29...3dcaa64.
|
|
@Akanksha-kedia, this page has been refactored in the Presto master branch. The refactoring should be published in the 0.287 release. Suggest you close this PR and make these changes in the file where this content is now, https://github.com/prestodb/presto/blob/master/presto-docs/src/main/sphinx/prestissimo/prestissimo-features.rst. |
steveburnett
left a comment
There was a problem hiding this comment.
@Akanksha-kedia, this looks okay overall in a local build, but this page has been refactored in the Presto master branch and the refactoring should be published in the 0.287 release.
Suggest you close this PR and make these changes in the file where this content is now, https://github.com/prestodb/presto/blob/master/presto-docs/src/main/sphinx/prestissimo/prestissimo-features.rst.
When you do so, could you see if you can also improve the formatting in lines 31-32 (the "POST: v1/memory" line and the following "Reports memory, but" line) as well? Screenshot for context.

@steveburnett how its passing for u ?
|
I don't know why the doc build fails for you and doesn't for me. How is it failing for you? Is this failure happening recently? This file hasn't changed in the ways you indicate cause build failure for you for a while. Also, I repeat that this page has been refactored in the Presto master branch, and the refactoring should be published in the 0.287 release. I suggest you close this PR and make these changes in the file where this content is now: https://github.com/prestodb/presto/blob/master/presto-docs/src/main/sphinx/prestissimo/prestissimo-features.rst. When you do so, could you see if you can also improve the formatting in lines 31-32 (the "POST: v1/memory" line and the following "Reports memory, but" line) as well? |
|
Closing this PR as
|


Description
Resolve Sphinx Documentation Build Errors in presto-native.rst
Motivation and Context
This PR addresses build errors in the Sphinx documentation caused by incorrect use of backquotes and title underlines that are too short. The errors occur in the presto-native.rst file.
The motivation for this change is to ensure the successful building of the documentation. Correctly formatting the backquotes and title underlines will resolve the build errors and improve the overall quality of the documentation.
Errors: The following errors were encountered during a manual build of the documentation using mvn install:
Impact
No impact. The issue was discovered during a manual build of the documentation. The error messages indicated that the backquotes and title underlines for several properties were incorrectly formatted, causing the build to fail.
Test Plan
Contributor checklist
Release Notes
Please follow release notes guidelines and fill in the release notes below.