Skip to content

Commit c13408f

Browse files
committed
Use the latest docs/source/conf.py from skeleton
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 0546960 commit c13408f

File tree

1 file changed

+7
-37
lines changed

1 file changed

+7
-37
lines changed

docs/source/conf.py

Lines changed: 7 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@
5353
),
5454
}
5555

56+
5657
# Add any paths that contain templates here, relative to this directory.
5758
templates_path = ["_templates"]
58-
# templates_path = ['../_templates']
5959

6060
# List of patterns, relative to source directory, that match files and
6161
# directories to ignore when looking for source files.
@@ -70,44 +70,17 @@
7070
#
7171
html_theme = "sphinx_rtd_theme"
7272

73-
# This adds to the levels displayed in the sidebar but the indent is wrong and expand/collapse doesn't work for the additional nodes.
74-
# It's a known issue: see https://stackoverflow.com/questions/14477396/how-to-expand-all-the-subsections-on-the-sidebar-toctree-in-sphinx and https://github.com/readthedocs/sphinx_rtd_theme/issues/455
75-
# html_theme_options = {
76-
# 'navigation_depth': 6,
77-
# }
78-
79-
html_theme_options = {
80-
"canonical_url": "",
81-
"analytics_id": "UA-XXXXXXX-1",
82-
"logo_only": False,
83-
# "display_version": True,
84-
# 'prev_next_buttons_location': 'bottom',
85-
# 'prev_next_buttons_location': 'top',
86-
"prev_next_buttons_location": "both",
87-
# 'style_external_links': False,
88-
# 'style_external_links': True,
89-
# 'style_nav_header_background': 'white',
90-
# Toc options
91-
# 'collapse_navigation': True,
92-
"collapse_navigation": False,
93-
# 'sticky_navigation': True,
94-
"sticky_navigation": False,
95-
# 'navigation_depth': 4,
96-
"navigation_depth": -1,
97-
"includehidden": True,
98-
"titles_only": False,
99-
}
100-
10173
# Add any paths that contain custom static files (such as style sheets) here,
10274
# relative to this directory. They are copied after the builtin static files,
10375
# so a file named "default.css" will overwrite the builtin "default.css".
10476
html_static_path = ["_static"]
105-
# html_static_path = ['../_static']
77+
78+
master_doc = "index"
10679

10780
html_context = {
10881
"display_github": True,
10982
"github_user": "nexB",
110-
"github_repo": "spats",
83+
"github_repo": "aboutcode-toolkit",
11184
"github_version": "develop", # branch
11285
"conf_py_path": "/docs/source/", # path in the checkout to the docs root
11386
}
@@ -116,9 +89,6 @@
11689
"theme_overrides.css",
11790
]
11891

119-
html_js_files = [
120-
"js/custom.js",
121-
]
12292

12393
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
12494
html_show_sphinx = True
@@ -127,6 +97,8 @@
12797
# .. role:: is used to refer to styles defined in _static/theme_overrides.css
12898
# and is used like this: :red:`text`
12999
rst_prolog = """
100+
.. |psf| replace:: Python Software Foundation
101+
130102
.. # define a hard line break for HTML
131103
.. |br| raw:: html
132104
@@ -142,6 +114,4 @@
142114

143115
# -- Options for LaTeX output -------------------------------------------------
144116

145-
latex_elements = {
146-
'classoptions': ',openany,oneside'
147-
}
117+
latex_elements = {"classoptions": ",openany,oneside"}

0 commit comments

Comments
 (0)