Skip to content

Commit 277ea7b

Browse files
doc: fine tune sphinx config
Signed-off-by: Andreas Reichel <andreas@manticore-projects.com> Signed-off-by: manticore-projects <andreas@manticore-projects.com>
1 parent 62dd4c1 commit 277ea7b

File tree

1 file changed

+34
-21
lines changed

1 file changed

+34
-21
lines changed

src/site/sphinx/conf.py

Lines changed: 34 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,39 +5,52 @@
55
sys.path.insert(0, os.path.abspath(".."))
66

77
# General options
8-
needs_sphinx = '7.2'
8+
needs_sphinx = "7.2"
99
add_function_parentheses = True
1010

11-
extensions = ['myst_parser', 'sphinx.ext.autodoc', 'sphinx.ext.autosectionlabel', 'sphinx.ext.extlinks', 'sphinx_substitution_extensions', 'sphinx_inline_tabs', 'pygments.sphinxext', ]
11+
extensions = [
12+
"myst_parser",
13+
"sphinx.ext.autodoc",
14+
"sphinx.ext.autosectionlabel",
15+
"sphinx.ext.extlinks",
16+
"sphinx_substitution_extensions",
17+
"sphinx_inline_tabs",
18+
"pygments.sphinxext",
19+
]
1220

13-
issues_github_path = "JSQLParser/JSqlParser"
1421

15-
source_encoding = 'utf-8-sig'
16-
#pygments_style = 'friendly'
22+
source_encoding = "utf-8-sig"
23+
# pygments_style = 'friendly'
1724
show_sphinx = False
18-
master_doc = 'index'
19-
exclude_patterns = ['_themes', '_static/css']
25+
master_doc = "index"
26+
exclude_patterns = ["_themes", "_static/css"]
2027
logo_only = True
2128

2229
# HTML options
2330
html_theme = "manticore_sphinx_theme"
2431
html_short_title = "JSQLParser"
25-
htmlhelp_basename = "JSQLParser" + '-doc'
32+
htmlhelp_basename = "JSQLParser" + "-doc"
2633
html_use_index = True
2734
html_show_sourcelink = False
28-
html_static_path = ['_static']
29-
html_logo = '_images/logo-no-background.svg'
30-
html_favicon = '_images/favicon.svg'
31-
html_css_files = ['svg.css']
35+
html_static_path = ["_static"]
36+
html_logo = "_images/logo-no-background.svg"
37+
html_favicon = "_images/favicon.svg"
38+
html_css_files = ["svg.css"]
3239

3340
html_theme_options = {
34-
'path_to_docs': 'site/sphinx',
35-
'repository_url': 'https://github.com/JSQLParser/JSqlParser',
36-
'repository_branch': 'master',
37-
'use_issues_button': True,
38-
'use_download_button': True,
39-
'use_fullscreen_button': True,
40-
'use_repository_button': True,
41+
"logo": "_images/logo-no-background.svg",
42+
"logo_alt": "JSQL Parser",
43+
"favicon": "_images/favicon.svg",
44+
"color_primary": "#0063db",
45+
"color_accent": "#d90000",
46+
"color_sidebar_bg": "#f5f6fa",
47+
"color_sidebar_text": "#2d2d48",
48+
"navigation_depth": 2,
49+
"show_breadcrumbs": True,
50+
"footer_text": "All rights reserved.",
51+
"show_powered_by": True,
52+
"repo_url": "https://github.com/JSQLParser/JSqlParse",
53+
"repo_name": "GitHub",
54+
"landing_page": "index",
55+
"collapse_navigation": True,
4156
}
42-
43-

0 commit comments

Comments
 (0)