|
31 | 31 |
|
32 | 32 | import os |
33 | 33 | import sys |
34 | | -import shlex |
35 | 34 | import subprocess |
36 | 35 | import datetime |
37 | 36 |
|
38 | | -sys.path.insert(0, os.path.abspath('.')) |
| 37 | +sys.path.insert(0, os.path.abspath(".")) |
39 | 38 |
|
40 | 39 | import sphinx_markdown_tables |
41 | 40 |
|
42 | 41 | source_suffix = { |
43 | | - '.rst': 'restructuredtext', |
44 | | - '.txt': 'restructuredtext', |
45 | | - '.md': 'markdown', |
| 42 | + ".rst": "restructuredtext", |
| 43 | + ".txt": "restructuredtext", |
| 44 | + ".md": "markdown", |
46 | 45 | } |
47 | 46 |
|
48 | 47 | # -- Project information ----------------------------------------------------- |
49 | 48 |
|
50 | | -project = 'Kyuubi' |
| 49 | +project = "Kyuubi" |
51 | 50 |
|
52 | 51 | year = datetime.datetime.now().strftime("%Y") |
53 | 52 |
|
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" |
55 | 54 |
|
56 | 55 |
|
57 | | -author = 'Apache Kyuubi Community' |
| 56 | +author = "Apache Kyuubi Community" |
58 | 57 |
|
59 | 58 | # The full version, including alpha/beta/rc tags |
60 | 59 | release = subprocess.getoutput("grep 'kyuubi-parent' -C1 ../pom.xml | grep '<version>' | awk -F '[<>]' '{print $3}'") |
|
63 | 62 | # -- General configuration --------------------------------------------------- |
64 | 63 |
|
65 | 64 | # 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 |
67 | 66 | # ones. |
68 | 67 | 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", |
78 | 77 | ] |
79 | 78 |
|
80 | | -master_doc = 'index' |
| 79 | +master_doc = "index" |
81 | 80 |
|
82 | 81 | # Add any paths that contain templates here, relative to this directory. |
83 | | -templates_path = ['_templates'] |
| 82 | +templates_path = ["_templates"] |
84 | 83 |
|
85 | 84 | # List of patterns, relative to source directory, that match files and |
86 | 85 | # directories to ignore when looking for source files. |
87 | 86 | # 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"] |
89 | 88 |
|
90 | 89 | # -- Options for HTML output ------------------------------------------------- |
91 | 90 |
|
92 | 91 | # The theme to use for HTML and HTML Help pages. See the documentation for |
93 | 92 | # a list of builtin themes. |
94 | 93 | # |
95 | | -html_theme = 'sphinx_book_theme' |
| 94 | +html_theme = "sphinx_book_theme" |
96 | 95 | html_theme_options = { |
97 | 96 | "repository_url": "https://github.com/apache/kyuubi", |
98 | 97 | "use_repository_button": True, |
|
108 | 107 | "toc_title": "", |
109 | 108 | } |
110 | 109 |
|
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" |
114 | 113 |
|
115 | | -pygments_style = 'sphinx' |
| 114 | +pygments_style = "sphinx" |
116 | 115 |
|
117 | 116 | # Add any paths that contain custom static files (such as style sheets) here, |
118 | 117 | # relative to this directory. They are copied after the builtin static files, |
119 | 118 | # so a file named "default.css" will overwrite the builtin "default.css". |
120 | | -html_static_path = ['_static'] |
| 119 | +html_static_path = ["_static"] |
121 | 120 | html_css_files = ["css/custom.css"] |
122 | 121 |
|
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