Remove warning logs during the document build process #13324
Merged
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
github-actions
bot
added
the
documentation
tlm365
force-pushed
the
sphinx_warn
branch
2 times, most recently
from
84dbf2c
to
bf9bc48
Compare
Signed-off-by: Tai Le Manh <manhtai.lmt@gmail.com>
jonathanc-n
approved these changes
Nov 10, 2024
alamb
approved these changes
Nov 10, 2024
There was a problem hiding this comment.
I tested the build locally and it works great. Thank you so much @tlm365
(venv) andrewlamb@Andrews-MacBook-Pro-2:~/Software/datafusion/docs$ ./build.sh
Running Sphinx v7.2.6
making output directory... done
[autosummary] generating autosummary for: contributor-guide/architecture.md, contributor-guide/communication.md, contributor-guide/getting_started.md, contributor-guide/governance.md, contributor-guide/howtos.md, contributor-guide/index.md, contributor-guide/inviting.md, contributor-guide/roadmap.md, contributor-guide/specification/index.rst, contributor-guide/specification/invariants.md, ..., user-guide/sql/information_schema.md, user-guide/sql/operators.md, user-guide/sql/scalar_functions.md, user-guide/sql/select.md, user-guide/sql/special_functions.md, user-guide/sql/sql_status.md, user-guide/sql/subqueries.md, user-guide/sql/window_functions.md, user-guide/sql/window_functions_new.md, user-guide/sql/write_options.md
myst v2.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'colon_fence', 'deflist', 'tasklist'}, disable_syntax=[], all_links_external=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=3, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 56 source files that are out of date
updating environment: [new config] 56 added, 0 changed, 0 removed
reading sources... [100%] user-guide/sql/write_options
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying downloadable files... [100%] ../core/tests/data/capitalized_example.csv
copying static files... done
copying extra files... done
done
writing output... [100%] user-guide/sql/write_options
generating indices... genindex done
highlighting module code...
writing additional pages... search done
copying images... [100%] _static/images/flamegraph.svg
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.
The HTML pages are in build/html.
|
|
||
| # Some code blocks (sql) are not being highlighted correctly, due to the | ||
| # presence of some special characters like: 🚀, å, {,... But this isn’t a major | ||
| # issue for our documentation. So, suppress these warnings to keep our build |
jayzhan211
pushed a commit
to jayzhan211/datafusion
that referenced
this pull request
Nov 12, 2024
Signed-off-by: Tai Le Manh <manhtai.lmt@gmail.com>
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.
Which issue does this PR close?
Closes #13320.
Rationale for this change
Make the build log cleaner.
What changes are included in this PR?
Are these changes tested?
Yes. Tested on my local machine.
Are there any user-facing changes?
No.