Skip to content

[DOC] Fix non-consecutive header level increase#7339

Closed
dnskr wants to merge 1 commit intoapache:masterfrom
dnskr:doc-fix-non-consecutive-header-level-increase
Closed

[DOC] Fix non-consecutive header level increase#7339
dnskr wants to merge 1 commit intoapache:masterfrom
dnskr:doc-fix-non-consecutive-header-level-increase

Conversation

@dnskr
Copy link
Contributor

@dnskr dnskr commented Mar 1, 2026

Why are the changes needed?

The changes fix the following warnings that are printed during the documentation building:

./kyuubi/docs/connector/spark/kudu.md.rst:42: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/connector/spark/kudu.md.rst:46: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/connector/spark/kudu.md.rst:50: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/connector/spark/kudu.md.rst:56: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/connector/spark/kudu.md.rst:82: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/connector/spark/kudu.md.rst:103: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/connector/spark/kudu.md.rst:121: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]

./kyuubi/docs/monitor/logging.md.rst:190: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/monitor/logging.md.rst:194: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/monitor/logging.md.rst:210: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/monitor/logging.md.rst:214: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]

How was this patch tested?

Checked that there are no warnings anymore during the documentation build process and the pages look the same.

make html

open _build/html/monitor/logging.html
open _build/html/connector/spark/kudu.html

Was this patch authored or co-authored using generative AI tooling?

No

Signed-off-by: dnskr <dnskrv88@gmail.com>
@github-actions github-actions bot added the kind:documentation Documentation is a feature! label Mar 1, 2026
@pan3793 pan3793 added this to the v1.12.0 milestone Mar 2, 2026
@pan3793 pan3793 closed this in ba7e057 Mar 2, 2026
@pan3793
Copy link
Member

pan3793 commented Mar 2, 2026

thanks, merged to master

dnskr added a commit that referenced this pull request Mar 2, 2026
### Why are the changes needed?
The changes fix the following warnings that are printed during the documentation building:
```
./kyuubi/docs/connector/spark/kudu.md.rst:42: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/connector/spark/kudu.md.rst:46: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/connector/spark/kudu.md.rst:50: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/connector/spark/kudu.md.rst:56: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/connector/spark/kudu.md.rst:82: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/connector/spark/kudu.md.rst:103: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/connector/spark/kudu.md.rst:121: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]

./kyuubi/docs/monitor/logging.md.rst:190: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/monitor/logging.md.rst:194: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/monitor/logging.md.rst:210: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
./kyuubi/docs/monitor/logging.md.rst:214: WARNING: Non-consecutive header level increase; H2 to H4 [myst.header]
```

### How was this patch tested?
Checked that there are no warnings anymore during the documentation build process and the pages look the same.
```
make html

open _build/html/monitor/logging.html
open _build/html/connector/spark/kudu.html
```

### Was this patch authored or co-authored using generative AI tooling?
No

Closes #7339 from dnskr/doc-fix-non-consecutive-header-level-increase.

Closes #7339

18fc95b [dnskr] [DOC] Fix non-consecutive header level increase

Authored-by: dnskr <dnskrv88@gmail.com>
Signed-off-by: Cheng Pan <chengpan@apache.org>
(cherry picked from commit ba7e057)
Signed-off-by: dnskr <dnskrv88@gmail.com>
@dnskr
Copy link
Contributor Author

dnskr commented Mar 2, 2026

Merged to branch-1.11 as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind:documentation Documentation is a feature!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants