Skip to content

docs: Fix doc build errors#27376

Merged
steveburnett merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-fix-build-errors
Mar 20, 2026
Merged

docs: Fix doc build errors#27376
steveburnett merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-fix-build-errors

Conversation

@steveburnett
Copy link
Copy Markdown
Contributor

@steveburnett steveburnett commented Mar 19, 2026

Description

Fixing the following five errors in Presto doc builds that have crept in over time.

/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/presto_cpp/properties-session.rst:601: WARNING: Title underline too short.

``native_aggregation_memory_compaction_reclaim_enabled``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [docutils]
/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/presto_cpp/properties-session.rst:601: WARNING: Title underline too short.

``native_aggregation_memory_compaction_reclaim_enabled``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [docutils]


/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/connector/hive.rst:324: ERROR: Content block expected for the "note" directive; none found. [docutils]
/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/connector/hive.rst:325: WARNING: Explicit markup ends without a blank line; unexpected unindent. [docutils]

/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/admin/jmx-metrics.rst:189: WARNING: Bullet list ends without a blank line; unexpected unindent. [docutils]

Motivation and Context

Reducing doc build errors when possible improves the doc build time, and improves the ability to debug doc builds by eliminating fixable errors in the doc build.

Impact

Documentation.

Test Plan

Local doc builds.

Before:
build succeeded, 61 warnings.

After, the five warnings shown above are gone from the doc build output:
build succeeded, 56 warnings.

Contributor checklist

  • Please make sure your submission complies with our contributing guide, in particular code style and commit standards.
  • 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.
  • If adding new dependencies, verified they have an OpenSSF Scorecard score of 5.0 or higher (or obtained explicit TSC approval for lower scores).

Release Notes

== NO RELEASE NOTE ==

Summary by Sourcery

Fix Sphinx documentation issues to reduce build warnings in the Presto docs.

Documentation:

  • Correct heading formatting in the C++ session properties documentation to satisfy Sphinx title rules.
  • Fix malformed note markup in the Hive connector documentation so it renders correctly.
  • Adjust list formatting in the JMX metrics admin documentation to avoid Sphinx list parsing warnings.

@steveburnett steveburnett self-assigned this Mar 19, 2026
@steveburnett steveburnett requested review from a team and elharo as code owners March 19, 2026 14:31
@prestodb-ci prestodb-ci added the from:IBM PR from IBM label Mar 19, 2026
@github-project-automation github-project-automation bot moved this to 🆕 Unprioritized in Presto Documentation Mar 19, 2026
@prestodb-ci prestodb-ci requested review from a team, NivinCS and sh-shamsan and removed request for a team March 19, 2026 14:31
@sourcery-ai
Copy link
Copy Markdown
Contributor

sourcery-ai bot commented Mar 19, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Fixes several Sphinx/reStructuredText formatting issues in Presto documentation to eliminate specific docutils warnings and one error during doc builds.

File-Level Changes

Change Details Files
Correct Sphinx heading markup for the native_aggregation_memory_compaction_reclaim_enabled session property to satisfy title underline length requirements.
  • Adjusted the underline length for the native_aggregation_memory_compaction_reclaim_enabled heading so it matches the heading text width.
  • Ensured the heading level and surrounding blank lines conform to Sphinx/reStructuredText conventions.
presto-docs/src/main/sphinx/presto_cpp/properties-session.rst
Fix malformed note directive in Hive connector docs that caused a docutils error and follow-on warning.
  • Added or fixed the content block following a .. note:: directive so it is no longer empty.
  • Inserted required blank line(s) after the note directive block to avoid explicit markup/unindent warnings.
  • Aligned indentation of the note body with Sphinx expectations.
presto-docs/src/main/sphinx/connector/hive.rst
Resolve bullet list formatting issue in JMX metrics docs to prevent list termination warning.
  • Added a trailing blank line after a bullet list to indicate the end of the list to docutils.
  • Adjusted indentation or spacing around the list so Sphinx no longer reports an unexpected unindent.
presto-docs/src/main/sphinx/admin/jmx-metrics.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@steveburnett steveburnett moved this from 🆕 Unprioritized to 👀 Review in Presto Documentation Mar 19, 2026
@steveburnett steveburnett requested a review from tdcmeehan March 19, 2026 14:31
Copy link
Copy Markdown
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Copy Markdown
Member

@hantangwangd hantangwangd left a comment

Choose a reason for hiding this comment

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

Thanks @steveburnett

@github-project-automation github-project-automation bot moved this from 👀 Review to ✅ Done in Presto Documentation Mar 20, 2026
Copy link
Copy Markdown
Contributor

@NivinCS NivinCS left a comment

Choose a reason for hiding this comment

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

LGTM !

@steveburnett steveburnett merged commit 2ff4adf into prestodb:master Mar 20, 2026
88 of 100 checks passed
@steveburnett steveburnett deleted the steveburnett-fix-build-errors branch March 20, 2026 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs from:IBM PR from IBM

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

4 participants