Skip to content

Commit

Permalink
use sphinx-rtd-theme
Browse files Browse the repository at this point in the history
  • Loading branch information
dannycolin committed Sep 11, 2023
1 parent 710d411 commit da98281
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 24 deletions.
42 changes: 42 additions & 0 deletions docs/en/images/bugzilla-logo-white.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 4 additions & 20 deletions docs/en/rst/_static/bugzilla.css
Original file line number Diff line number Diff line change
@@ -1,21 +1,5 @@
@import 'default.css';

dt { font-weight: bold; }

/* Custom roles */
.param { font-weight: bold; }
.paramval { font-family: monospace; }
.group { font-family: monospace; }
.field { font-weight: bold; }
.command { font-family: monospace; font-size: 130% }

.admonition-todo {
background-color: lightpink;
border: 2px darkred solid;
}

/* Make Buggie's antenna not take up so much space */
.logo {
display: block;
margin-top: -20px;
.wy-side-nav-search .wy-dropdown > a img.logo,
.wy-side-nav-search > a img.logo {
min-width: 150px;
width: 350px;
}
27 changes: 23 additions & 4 deletions docs/en/rst/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -128,12 +128,31 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = "sphinx_rtd_theme"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
html_theme_options = {
#'analytics_id': 'G-XXXXXXXXXX', # Provided by Google in your dashboard
#'analytics_anonymize_ip': False,
'logo_only': True,
'display_version': True,
'prev_next_buttons_location': 'bottom',
'style_external_links': False,
'vcs_pageview_mode': '',
#'style_nav_header_background': 'white',
# Toc options
'collapse_navigation': True,
'sticky_navigation': True,
'navigation_depth': 4,
'includehidden': True,
'titles_only': False
}

html_css_files = [
"bugzilla.css"
]

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
Expand All @@ -145,11 +164,11 @@
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None

html_style = "bugzilla.css"
#html_style = "bugzilla.css"

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = "../images/bugzilla.png"
html_logo = "../images/bugzilla-logo-white.svg"

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
Expand Down
3 changes: 3 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
sphinx==5.3.0
sphinx_rtd_theme==1.3.0
readthedocs-sphinx-search==0.3.1

0 comments on commit da98281

Please sign in to comment.