[docs] Fix doc build errors #23090
Merged
[docs] Fix doc build errors #23090
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tdcmeehan
approved these changes
Jun 26, 2024
rschlussel
reviewed
Jun 27, 2024
| @@ -181,7 +181,7 @@ queries. | |||
| * Array checksum of the value set | |||
| * **Row Columns** | |||
| * Checksums row fields recursively according to the type of the fields. | |||
| * For all other column types, generates a simple checksum using the :func:`checksum` function. | |||
| * For all other column types, generates a simple checksum using the :func:`!checksum` function. | |||
There was a problem hiding this comment.
what does adding the exclamation point do?
There was a problem hiding this comment.
My understanding is it's because we generate the links for :func: using some custom code, and so during initial rendering it throws a warning. That is how I understood it from #23023
rschlussel
approved these changes
Jun 27, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes the following doc build errors:
WARNING: html_static_path entry 'static' does not exist/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/language/types.rst:3: WARNING: Duplicate explicit target name: "hyperloglog"./Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/security/internal-communication.rst:131: WARNING: undefined label: 'config-properties'/Users/steveburnett/Documents/GitHub/presto/presto-docs/src/main/sphinx/functions/array.rst:83: WARNING: Literal block expected; none found.Motivation and Context
Chips away at the remaining doc build errors, and builds on the work in #23033 , #23023, #22876 , and #22985 .
Like the doc build errors I fixed in the other PRs, these errors don't stop the build but they're annoying, and these are easy and low-risk fixes.
Keeping the number of changes small to make reviewing easier and faster. Also, the remaining errors require more time to solve, so submit these solved problems for velocity.
Impact
Documentation.
Test Plan
Local doc build.
Before the fixes in this PR:
build succeeded, 23 warnings.
After:
build succeeded, 19 warnings.
Contributor checklist
Release Notes