Skip to content

Commit 3b7dc55

Browse files
committed
Update sphinx theme
Use the default readthedocs theme instead of our custom theme. This ensure we use the same theme for both 5.x and 6.x documentation. We also benefit from niceties included in the latest readthedocs theme that our custom theme doesn't provide (e.g better mobile layout).
1 parent fcd8aa8 commit 3b7dc55

File tree

3 files changed

+69
-26
lines changed

3 files changed

+69
-26
lines changed
Lines changed: 42 additions & 0 deletions
Loading

docs/en/rst/_static/bugzilla.css

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,4 @@
1-
@import 'default.css';
2-
3-
dt { font-weight: bold; }
4-
5-
/* Custom roles */
6-
.param { font-weight: bold; }
7-
.paramval { font-family: monospace; }
8-
.group { font-family: monospace; }
9-
.field { font-weight: bold; }
10-
.command { font-family: monospace; font-size: 130% }
11-
12-
.admonition-todo {
13-
background-color: lightpink;
14-
border: 2px darkred solid;
15-
}
16-
17-
/* Make Buggie's antenna not take up so much space */
18-
.logo {
19-
display: block;
20-
margin-top: -20px;
21-
}
1+
.wy-side-nav-search .wy-dropdown > a img.logo,
2+
.wy-side-nav-search > a img.logo {
3+
min-width: 150px;
4+
width: 350px;

docs/en/rst/conf.py

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,12 +128,31 @@
128128

129129
# The theme to use for HTML and HTML Help pages. See the documentation for
130130
# a list of builtin themes.
131-
html_theme = 'default'
131+
html_theme = 'sphinx_rtd_theme'
132132

133133
# Theme options are theme-specific and customize the look and feel of a theme
134134
# further. For a list of options available for each theme, see the
135135
# documentation.
136-
#html_theme_options = {}
136+
html_theme_options = {
137+
#'analytics_id': 'G-XXXXXXXXXX', # Provided by Google in your dashboard
138+
#'analytics_anonymize_ip': False,
139+
'logo_only': True,
140+
'display_version': True,
141+
'prev_next_buttons_location': 'bottom',
142+
'style_external_links': False,
143+
'vcs_pageview_mode': '',
144+
#'style_nav_header_background': 'white',
145+
# Toc options
146+
'collapse_navigation': True,
147+
'sticky_navigation': True,
148+
'navigation_depth': 4,
149+
'includehidden': True,
150+
'titles_only': False
151+
}
152+
153+
html_css_files = [
154+
"bugzilla.css"
155+
]
137156

138157
# Add any paths that contain custom themes here, relative to this directory.
139158
#html_theme_path = []
@@ -144,12 +163,11 @@
144163

145164
# A shorter title for the navigation bar. Default is the same as html_title.
146165
#html_short_title = None
147-
148-
html_style = "bugzilla.css"
166+
#html_style = "bugzilla.css"
149167

150168
# The name of an image file (relative to this directory) to place at the top
151169
# of the sidebar.
152-
html_logo = "../images/bugzlla.png"
170+
html_logo = "../images/bugzlla-logo-white.svg"
153171

154172
# The name of an image file (within the static path) to use as favicon of the
155173
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32

0 commit comments

Comments
 (0)