Skip to content

Resolve Sphinx Documentation Build Errors in presto-native.rst#22311

Closed
Akanksha-kedia wants to merge 1 commit intoprestodb:masterfrom
Akanksha-kedia:native
Closed

Resolve Sphinx Documentation Build Errors in presto-native.rst#22311
Akanksha-kedia wants to merge 1 commit intoprestodb:masterfrom
Akanksha-kedia:native

Conversation

@Akanksha-kedia
Copy link
Contributor

@Akanksha-kedia Akanksha-kedia commented Mar 23, 2024

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:

  1. Incorrect use of backquotes for code formatting at line 19.
  2. Title underline too short for connector.num-io-threads-hw-multiplier at line 145.
  3. Title underline too short for enable-old-task-cleanup at line 174.

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

  1. Apply the changes from this PR.
  2. Run mvn install to build the documentation.
  3. Open target/html/index.html in a web browser to verify that the documentation builds successfully and the updated sections display correctly.

Contributor checklist

  • Please make sure your submission complies with our development, formatting, commit message, and attribution guidelines.
  • PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
  • Documented new properties (with its default value), SQL syntax, functions, or other functionality.
  • If release notes are required, they follow the release notes guidelines.
  • Adequate tests were added if applicable.
  • CI passed.

Release Notes

Please follow release notes guidelines and fill in the release notes below.

== NO RELEASE NOTE ==

@Akanksha-kedia Akanksha-kedia requested review from a team and steveburnett as code owners March 23, 2024 09:17
@github-actions
Copy link

Codenotify: Notifying subscribers in CODENOTIFY files for diff 48c5a29...3dcaa64.

Notify File(s)
@steveburnett presto-docs/src/main/sphinx/develop/presto-native.rst

@github-actions github-actions bot added the docs label Mar 23, 2024
@steveburnett
Copy link
Contributor

@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.

Copy link
Contributor

@steveburnett steveburnett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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.
Screenshot 2024-03-25 at 3 03 17 PM

@Akanksha-kedia
Copy link
Contributor Author

Screenshot 2024-03-30 at 3 24 01 PM @steveburnett how its passing for u ?

@steveburnett
Copy link
Contributor

@steveburnett how its passing for u ?
I get many warnings, and always have since I began working with Presto documentation, but as you see in this screenshot the doc build succeeds for me.

Screenshot 2024-04-01 at 2 17 16 PM

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?

@steveburnett
Copy link
Contributor

Closing this PR as

  • presto-docs/src/main/sphinx/develop/presto-native.rst was deleted in PR 22392 (after a refactoring of the content to the new file presto-docs/src/main/sphinx/prestissimo/prestissimo-features.rst in PR 21953)
  • the heading format errors transferred to presto-docs/src/main/sphinx/prestissimo/prestissimo-features.rst by the refactoring have been addressed and merged in PR 22398

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants