Skip to content

Commit 4c81ae3

Browse files
committed
[KYUUBI #6981] [DOC] Fix nested lists
### Why are the changes needed? The PR fixes [nested lists formatting](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#lists-and-quote-like-blocks) and resolves the following warnings: ```shell ../kyuubi/docs/contributing/doc/style.rst:65: WARNING: Bullet list ends without a blank line; unexpected unindent. [docutils] ../kyuubi/docs/contributing/doc/style.rst:67: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils] ../kyuubi/docs/contributing/doc/style.rst:68: WARNING: Bullet list ends without a blank line; unexpected unindent. [docutils] ../kyuubi/docs/contributing/doc/style.rst:73: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils] ../kyuubi/docs/contributing/doc/style.rst:106: WARNING: Bullet list ends without a blank line; unexpected unindent. [docutils] ../kyuubi/docs/contributing/doc/style.rst:107: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils] ``` ### How was this patch tested? Built documentation locally and checked nested lists are fixed. Before changes: <img width="914" alt="image" src="https://github.com/user-attachments/assets/3ec7079a-e494-4614-9af0-d6e217bcad60" /> After changes: <img width="1020" alt="image" src="https://github.com/user-attachments/assets/2d3b3231-094d-49bd-b3d7-c6149e13c939" /> ### Was this patch authored or co-authored using generative AI tooling? No Closes #6981 from dnskr/doc-fix-nested-lists. Closes #6981 4b425f2 [dnskr] [DOC] Fix nested lists Authored-by: dnskr <dnskrv88@gmail.com> Signed-off-by: dnskr <dnskrv88@gmail.com>
1 parent d0d24cd commit 4c81ae3

File tree

1 file changed

+16
-12
lines changed

1 file changed

+16
-12
lines changed

docs/contributing/doc/style.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -59,17 +59,20 @@ ReStructuredText
5959
Headings
6060
~~~~~~~~
6161

62-
- Use **Pascal Case**, every word starts with an uppercase letter,
63-
e.g., 'Documentation Style Guide'
62+
- Use **Pascal Case**, every word starts with an uppercase letter, e.g., 'Documentation Style Guide'
6463
- Use a max of **three levels**
65-
- Split into multiple files when there comes an H4
66-
- Prefer `directive rubric`_ than H4
64+
65+
- Split into multiple files when there comes an H4
66+
- Prefer `directive rubric`_ than H4
67+
6768
- Use underline-only adornment styles, **DO NOT** use overline
68-
- The length of underline characters **SHOULD** match the title
69-
- H1 should be underlined with '='
70-
- H2 should be underlined with '-'
71-
- H3 should be underlined with '~'
72-
- H4 should be underlined with '^', but it's better to avoid using H4
69+
70+
- The length of underline characters **SHOULD** match the title
71+
- H1 should be underlined with '='
72+
- H2 should be underlined with '-'
73+
- H3 should be underlined with '~'
74+
- H4 should be underlined with '^', but it's better to avoid using H4
75+
7376
- **DO NOT** use numbering for sections
7477
- **DO NOT** use "Kyuubi" in titles if possible
7578

@@ -100,10 +103,11 @@ Markdown
100103
Headings
101104
~~~~~~~~
102105

103-
- Use **Pascal Case**, every word starts with an uppercase letter,
104-
e.g., 'Documentation Style Guide'
106+
- Use **Pascal Case**, every word starts with an uppercase letter, e.g., 'Documentation Style Guide'
105107
- Use a max of **three levels**
106-
- Split into multiple files when there comes an H4
108+
109+
- Split into multiple files when there comes an H4
110+
107111
- **DO NOT** use numbering for sections
108112
- **DO NOT** use "Kyuubi" in titles if possible
109113

0 commit comments

Comments
 (0)