Skip to content

Commit 2d7e496

Browse files
committed
[KYUUBI #7502] [DOC] Align Python version and style
### Why are the changes needed? The changes align: - Python version used for the documentation build in `.github/workflows/docs.yml` with [.readthedocs.yaml](https://github.com/apache/kyuubi/blob/26e3eaa93ea354245866526a697a16f23ed77455/.readthedocs.yaml#L22). - Quotes used for strings in `docs/conf.py`. ### How was this patch tested? Built and verify the documentation. ```shell make html open _build/html/overview/kyuubi_vs_hive.html ``` ### Was this patch authored or co-authored using generative AI tooling? No Closes #7502 from dnskr/doc-align-python-version-and-style. Closes #7502 4363c40 [Denis Krivenko] [DOC] Align Python version and style Authored-by: Denis Krivenko <dnskrv88@gmail.com> Signed-off-by: Denis Krivenko <dnskrv88@gmail.com> (cherry picked from commit a97592e) Signed-off-by: Denis Krivenko <dnskrv88@gmail.com>
1 parent 75d39ee commit 2d7e496

2 files changed

Lines changed: 28 additions & 29 deletions

File tree

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ jobs:
3434
- uses: actions/checkout@v4
3535
- uses: actions/setup-python@v5
3636
with:
37-
python-version: '3.10'
37+
python-version: '3.11'
3838
cache: 'pip'
3939
cache-dependency-path: docs/requirements.txt
4040
- run: pip install -r docs/requirements.txt

docs/conf.py

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -31,30 +31,29 @@
3131

3232
import os
3333
import sys
34-
import shlex
3534
import subprocess
3635
import datetime
3736

38-
sys.path.insert(0, os.path.abspath('.'))
37+
sys.path.insert(0, os.path.abspath("."))
3938

4039
import sphinx_markdown_tables
4140

4241
source_suffix = {
43-
'.rst': 'restructuredtext',
44-
'.txt': 'restructuredtext',
45-
'.md': 'markdown',
42+
".rst": "restructuredtext",
43+
".txt": "restructuredtext",
44+
".md": "markdown",
4645
}
4746

4847
# -- Project information -----------------------------------------------------
4948

50-
project = 'Kyuubi'
49+
project = "Kyuubi"
5150

5251
year = datetime.datetime.now().strftime("%Y")
5352

54-
copyright = year + ' The Apache Software Foundation, Licensed under the Apache License, Version 2.0'
53+
copyright = year + " The Apache Software Foundation, Licensed under the Apache License, Version 2.0"
5554

5655

57-
author = 'Apache Kyuubi Community'
56+
author = "Apache Kyuubi Community"
5857

5958
# The full version, including alpha/beta/rc tags
6059
release = subprocess.getoutput("grep 'kyuubi-parent' -C1 ../pom.xml | grep '<version>' | awk -F '[<>]' '{print $3}'")
@@ -63,36 +62,36 @@
6362
# -- General configuration ---------------------------------------------------
6463

6564
# Add any Sphinx extension module names here, as strings. They can be
66-
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
65+
# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
6766
# ones.
6867
extensions = [
69-
'sphinx.ext.autodoc',
70-
'sphinx.ext.napoleon',
71-
'sphinx.ext.mathjax',
72-
'myst_parser',
73-
'sphinx_copybutton',
74-
'sphinx_markdown_tables',
75-
'sphinx_togglebutton',
76-
'notfound.extension',
77-
'sphinxemoji.sphinxemoji',
68+
"sphinx.ext.autodoc",
69+
"sphinx.ext.napoleon",
70+
"sphinx.ext.mathjax",
71+
"myst_parser",
72+
"sphinx_copybutton",
73+
"sphinx_markdown_tables",
74+
"sphinx_togglebutton",
75+
"notfound.extension",
76+
"sphinxemoji.sphinxemoji",
7877
]
7978

80-
master_doc = 'index'
79+
master_doc = "index"
8180

8281
# Add any paths that contain templates here, relative to this directory.
83-
templates_path = ['_templates']
82+
templates_path = ["_templates"]
8483

8584
# List of patterns, relative to source directory, that match files and
8685
# directories to ignore when looking for source files.
8786
# This pattern also affects html_static_path and html_extra_path.
88-
exclude_patterns = ['requirements.txt', '_build', 'Thumbs.db', '.DS_Store']
87+
exclude_patterns = ["requirements.txt", "_build", "Thumbs.db", ".DS_Store"]
8988

9089
# -- Options for HTML output -------------------------------------------------
9190

9291
# The theme to use for HTML and HTML Help pages. See the documentation for
9392
# a list of builtin themes.
9493
#
95-
html_theme = 'sphinx_book_theme'
94+
html_theme = "sphinx_book_theme"
9695
html_theme_options = {
9796
"repository_url": "https://github.com/apache/kyuubi",
9897
"use_repository_button": True,
@@ -108,16 +107,16 @@
108107
"toc_title": "",
109108
}
110109

111-
html_logo = 'imgs/logo.png'
112-
html_favicon = 'imgs/logo_red_short.png'
113-
html_title = 'Apache Kyuubi'
110+
html_logo = "imgs/logo.png"
111+
html_favicon = "imgs/logo_red_short.png"
112+
html_title = "Apache Kyuubi"
114113

115-
pygments_style = 'sphinx'
114+
pygments_style = "sphinx"
116115

117116
# Add any paths that contain custom static files (such as style sheets) here,
118117
# relative to this directory. They are copied after the builtin static files,
119118
# so a file named "default.css" will overwrite the builtin "default.css".
120-
html_static_path = ['_static']
119+
html_static_path = ["_static"]
121120
html_css_files = ["css/custom.css"]
122121

123-
github_doc_root = 'https://github.com/apache/kyuubi/tree/master/docs/'
122+
github_doc_root = "https://github.com/apache/kyuubi/tree/master/docs/"

0 commit comments

Comments
 (0)