Skip to content

[docs] Fix errors in doc build#22985

Merged
steveburnett merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-build-errors
Jun 11, 2024
Merged

[docs] Fix errors in doc build#22985
steveburnett merged 1 commit intoprestodb:masterfrom
steveburnett:steveburnett-build-errors

Conversation

@steveburnett
Copy link
Contributor

@steveburnett steveburnett commented Jun 11, 2024

Description

Fixes the following errors in the Presto documentation build (errors taken from a local doc build):

  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/cache/local.rst:53: ERROR: Unexpected indentation.
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/connector/sqlserver.rst:64: WARNING: Explicit markup ends without a blank line; unexpected unindent.
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/router.rst:1: WARNING: Title overline too short.
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/release/release-0.273.rst:44: WARNING: Title underline too short.
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/release/release-0.285.rst:27: WARNING: Inline literal start-string without end-string.
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/release/release-0.271.rst:13: ERROR: Unexpected indentation.
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/release/release-0.258.rst:17: WARNING: Title underline too short.
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/release/release-0.259.rst:5: ERROR: Content block expected for the "warning" directive; none found.
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/release/release-0.259.rst:6: WARNING: Explicit markup ends without a blank line; unexpected unindent.
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/connector/hudi.rst:22: WARNING: Bullet list ends without a blank line; unexpected unindent.
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/release/release-0.248.1.rst: WARNING: document isn't included in any toctree
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/release/release-0.279.2.rst: WARNING: document isn't included in any toctree
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/functions/pinot.rst: WARNING: document isn't included in any toctree
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/functions/array.rst:143: WARNING: Literal block expected; none found.
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/functions/comparison.rst:165: WARNING: Literal block expected; none found.
  • /Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/functions/window.rst:18: WARNING: Lexing literal_block '{RANGE|ROWS|GROUPS} frame_start\n{RANGE|ROWS|GROUPS} BETWEEN frame_start AND frame_end' as "sql" resulted in an error at token: '{'. Retrying in relaxed mode.

Motivation and Context

Like the doc build errors I fixed in #22876, these errors don't stop the build but they're annoying, and these are easy and low-risk fixes.

Impact

Fewer errors in the doc build.

Test Plan

Local doc builds. Also, CI.

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

== NO RELEASE NOTE ==

@steveburnett steveburnett requested a review from a team as a code owner June 11, 2024 15:29
@steveburnett steveburnett requested a review from presto-oss June 11, 2024 15:29
@steveburnett steveburnett self-assigned this Jun 11, 2024
@steveburnett steveburnett changed the title Fix errors in doc build [docs] Fix errors in doc build Jun 11, 2024
@github-actions github-actions bot added the docs label Jun 11, 2024
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.

4 participants

Comments