alamb opened a new issue, #13320:
URL: https://github.com/apache/datafusion/issues/13320
### Describe the bug
I noticed that building the documentation generates a bunch of warnings;
### To Reproduce
```shell
cd docs
./build.sh
```
Here is an example of what happens:
```
(venv) andrewlamb@Andrews-MBP-2:~/Software/datafusion2/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={'tasklist', 'deflist', 'colon_fence'}, 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
/Users/andrewlamb/Software/datafusion2/docs/temp/library-user-guide/profiling.md:24:
WARNING: Non-consecutive header level increase; H1 to H3 [myst.header]
/Users/andrewlamb/Software/datafusion2/docs/temp/library-user-guide/profiling.md:37:
WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
/Users/andrewlamb/Software/datafusion2/docs/temp/library-user-guide/profiling.md:45:
WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
/Users/andrewlamb/Software/datafusion2/docs/temp/library-user-guide/profiling.md:49:
WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
/Users/andrewlamb/Software/datafusion2/docs/temp/library-user-guide/profiling.md:59:
WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
/Users/andrewlamb/Software/datafusion2/docs/temp/library-user-guide/profiling.md:69:
WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
/Users/andrewlamb/Software/datafusion2/docs/temp/library-user-guide/profiling.md:75:
WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying downloadable files... [100%]
../../datafusion/core/tests/data/capitalized_example.csv
copying static files... done
copying extra files... done
done
writing output... [100%] user-guide/sql/write_options
/Users/andrewlamb/Software/datafusion2/docs/temp/contributor-guide/howtos.md:59:
WARNING: 'myst' cross-reference target not found:
'../../../datafusion/expr/src/aggregate_function.rs' [myst.xref_missing]
/Users/andrewlamb/Software/datafusion2/docs/temp/library-user-guide/query-optimizer.md:70:
WARNING: 'myst' cross-reference target not found:
'../../datafusion-examples/examples/optimizer_rule.rs' [myst.xref_missing]
/Users/andrewlamb/Software/datafusion2/docs/temp/user-guide/sql/scalar_functions.md:3957:
WARNING: 'myst' cross-reference target not found: 'map_extract'
[myst.xref_missing]
/Users/andrewlamb/Software/datafusion2/docs/temp/user-guide/sql/scalar_functions.md:3963:
WARNING: 'myst' cross-reference target not found: 'map_extract'
[myst.xref_missing]
/Users/andrewlamb/Software/datafusion2/docs/temp/user-guide/sql/scalar_functions.md:875:
WARNING: Lexing literal_block '> select
chr(128640);\n+--------------------+\n| chr(Int64(128640))
|\n+--------------------+\n| 🚀 |\n+--------------------+\n' as
"sql" resulted in an error at token: '🚀'. Retrying in relaxed mode.
/Users/andrewlamb/Software/datafusion2/docs/temp/user-guide/sql/scalar_functions.md:1125:
WARNING: Lexing literal_block '> select
lower(\'Ångström\');\n+-------------------------+\n| lower(Utf8("Ångström"))
|\n+-------------------------+\n| ångström
|\n+-------------------------+\n' as "sql" resulted in an error at token: 'Ã¥'.
Retrying in relaxed mode.
/Users/andrewlamb/Software/datafusion2/docs/temp/user-guide/sql/scalar_functions.md:3881:
WARNING: Lexing literal_block '> select * from t;\n+---+---+\n| a | b
|\n+---+---+\n| 1 | 2 |\n| 3 | 4 |\n+---+---+\n> select
named_struct(\'field_a\', a, \'field_b\', b) from
t;\n+-------------------------------------------------------+\n|
named_struct(Utf8("field_a"),t.a,Utf8("field_b"),t.b)
|\n+-------------------------------------------------------+\n| {field_a: 1,
field_b: 2} |\n| {field_a: 3, field_b: 4}
|\n+-------------------------------------------------------+\n' as "sql"
resulted in an error at token: '{'. Retrying in relaxed mode.
/Users/andrewlamb/Software/datafusion2/docs/temp/user-guide/sql/scalar_functions.md:3921:
WARNING: Lexing literal_block '> select * from t;\n+---+---+\n| a | b
|\n+---+---+\n| 1 | 2 |\n| 3 | 4 |\n+---+---+\n\n-- use default names `c0`,
`c1`\n> select struct(a, b) from t;\n+-----------------+\n| struct(t.a,t.b)
|\n+-----------------+\n| {c0: 1, c1: 2} |\n| {c0: 3, c1: 4}
|\n+-----------------+\n\n-- name the first field `field_a`\nselect struct(a as
field_a, b) from t;\n+--------------------------------------------------+\n|
named_struct(Utf8("field_a"),t.a,Utf8("c1"),t.b)
|\n+--------------------------------------------------+\n| {field_a: 1, c1: 2}
|\n| {field_a: 3, c1: 4}
|\n+--------------------------------------------------+\n' as "sql" resulted
in an error at token: '{'. Retrying in relaxed mode.
/Users/andrewlamb/Software/datafusion2/docs/temp/user-guide/sql/scalar_functions.md:3986:
WARNING: Lexing literal_block " -- Using map function\n SELECT
MAP('type', 'test');\n ----\n {type: test}\n\n SELECT
MAP(['POST', 'HEAD', 'PATCH'], [41, 33, null]);\n ----\n {POST:
41, HEAD: 33, PATCH: }\n\n SELECT MAP([[1,2], [3,4]], ['a', 'b']);\n
----\n {[1, 2]: a, [3, 4]: b}\n\n SELECT MAP { 'a': 1, 'b': 2
};\n ----\n {a: 1, b: 2}\n\n -- Using make_map function\n
SELECT MAKE_MAP(['POST', 'HEAD'], [41, 33]);\n ----\n
{POST: 41, HEAD: 33}\n\n SELECT MAKE_MAP(['key1', 'key2'], ['value1',
null]);\n ----\n {key1: value1, key2: }\n ```\n\n\n###
`map_extract`\n\nReturns a list containing the value for the given key or an
empty list if the key is not present in the map.\n\n" as "sql" resulted in an
error at token: '{'. Retrying in relaxed mode.
/Users/andrewlamb/Software/datafusion2/docs/temp/user-guide/sql/scalar_functions.md:4063:
WARNING: Lexing literal_block "SELECT map_keys(MAP {'a': 1, 'b': NULL, 'c':
3});\n----\n[a, b, c]\n\nSELECT map_keys(map([100, 5], [42, 43]));\n----\n[100,
5]\n" as "sql" resulted in an error at token: '{'. Retrying in relaxed mode.
/Users/andrewlamb/Software/datafusion2/docs/temp/user-guide/sql/scalar_functions.md:4087:
WARNING: Lexing literal_block "SELECT map_values(MAP {'a': 1, 'b': NULL, 'c':
3});\n----\n[1, , 3]\n\nSELECT map_values(map([100, 5], [42, 43]));\n----\n[42,
43]\n" as "sql" resulted in an error at token: '{'. Retrying in relaxed mode.
/Users/andrewlamb/Software/datafusion2/docs/temp/user-guide/sql/scalar_functions.md:4329:
WARNING: Lexing literal_block "> create table t (idx varchar, v varchar) as
values ('data','fusion'), ('apache', 'arrow');\n> select struct(idx, v) from t
as c;\n+-------------------------+\n| struct(c.idx,c.v)
|\n+-------------------------+\n| {c0: data, c1: fusion} |\n| {c0: apache, c1:
arrow} |\n+-------------------------+\n> select get_field((select struct(idx,
v) from t), 'c0');\n+-----------------------+\n| struct(t.idx,t.v)[c0]
|\n+-----------------------+\n| data |\n| apache
|\n+-----------------------+\n> select get_field((select struct(idx, v) from
t), 'c1');\n+-----------------------+\n| struct(t.idx,t.v)[c1]
|\n+-----------------------+\n| fusion |\n| arrow
|\n+-----------------------+\n" as "sql" resulted in an error at token: '{'.
Retrying in relaxed mode.
/Users/andrewlamb/Software/datafusion2/docs/temp/user-guide/sql/special_functions.md:80:
WARNING: Lexing literal_block "> create table foo as values ({a: 5, b: 'a
string'}), ({a:6, b: 'another string'});\n\n> create view foov as select
column1 as struct_column from foo;\n\n> select * from
foov;\n+---------------------------+\n| struct_column
|\n+---------------------------+\n| {a: 5, b: a string} |\n| {a: 6, b:
another string} |\n+---------------------------+\n\n> select
unnest(struct_column) from
foov;\n+------------------------------------------+------------------------------------------+\n|
unnest_placeholder(foov.struct_column).a |
unnest_placeholder(foov.struct_column).b
|\n+------------------------------------------+------------------------------------------+\n|
5 | a string
|\n| 6 | another string
|\n+---------------------
---------------------+------------------------------------------+\n" as "sql"
resulted in an error at token: '{'. Retrying in relaxed mode.
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, 20 warnings.
```
### Expected behavior
Instead of
> build succeeded, 20 warnings.
I hope to see
build succeeded, 0 warnings.
### Additional context
_No response_
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
