Skip to content

Commit

Permalink
Switch to alabaster doc theme
Browse files Browse the repository at this point in the history
  • Loading branch information
fr33jc committed Feb 21, 2015
1 parent 1eceb50 commit a204e06
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 20 deletions.
24 changes: 12 additions & 12 deletions doc/_static/banglogo.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 17 additions & 8 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
# All configuration values have a default; values that are commented out
# serve to show the default.

import alabaster
import os.path
import sys

Expand All @@ -35,6 +36,7 @@
'sphinx.ext.autodoc',
'sphinx.ext.viewcode',
'sphinxarg.ext',
'alabaster',
]

# Add any paths that contain templates here, relative to this directory.
Expand Down Expand Up @@ -110,14 +112,12 @@ def setup(app):

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "default"
html_theme = 'alabaster'
html_theme_options = {
"stickysidebar": "true",
"relbarbgcolor": "black",
"sidebarbgcolor": "#333333",
"footerbgcolor": "#333333",
"sidebarlinkcolor": "#9999aa",
}
'logo': 'banglogo.svg',
'github_user': 'fr33jc',
'github_repo': 'bang',
}

# 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
Expand All @@ -126,6 +126,7 @@ def setup(app):

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
html_theme_path = [alabaster.get_path()]

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
Expand All @@ -136,7 +137,7 @@ def setup(app):

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
html_logo = '_static/banglogo.svg'
#html_logo = '_static/banglogo.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 All @@ -158,6 +159,14 @@ def setup(app):

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
html_sidebars = {
'**': [
'about.html',
'navigation.html',
'searchbox.html',
'donate.html',
]
}

# Additional templates that should be rendered to pages, maps page names to
# template names.
Expand Down
5 changes: 5 additions & 0 deletions etc/docreqs.pip
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,8 @@ Sphinx==1.2.3
# - License: MIT
sphinx-argparse==0.1.13

# alabaster
# - https://github.com/bitprophet/alabaster
# - sphinx theme inspired by the original flask site
# - License: BSD 3-clause
alabaster==0.6.3

0 comments on commit a204e06

Please sign in to comment.