Skip to content

Commit

Permalink
Use RTD theme (as demo in online docs)
Browse files Browse the repository at this point in the history
This branch serves as an example in the rendered documentation. It
should always be rebased on the latest release.
  • Loading branch information
goerz committed Dec 14, 2020
1 parent 95a723f commit 5ccb0ce
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 18 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ matrix:
- secure: IdnVMQ3YKHWDGNiafA96+aik7sa+XM4F6QpFz9MiVsGVgVNS0mZvO5iDkxIK96APuAUJOc33+LbYo4kiHYyFqUjtHsNF3/DriLVcEjlHnePVe6tlbW7Z6tel2wBvegxyE0fLe87yaq/tGy9AENp9FvrRboIiusWdIa5upzRduBLiAZUgOe8AOiQBVxNYtkIrH5/CUepZUv/V8ELWeDSbP/UMSHOLehJJXVr00V2ZYWIRFlFx2UhkisiNkxXP2gDuzn/sL5eLNc47BnXoKWMVXGaR4EkJrlIZINXZVPunl+buzayzqqv5Q4UUxh7BN2LaQ4MeH3j+rU+cCYaBzumG5V8LnbS4eXf5IPoXnyoPc8fSDU9jf2XTGw866iD7fLsS3mz2ZHKaX6gGP1y2g3uCAEGJJckS/tCilJ6AxtZS+UBaNIIOahD2Pge1s6DkeM/f4yWWaY526nG5cbkT89KjaWevY1qQSHqglbG4FJr7Qx2J7cd9/iimEkE/SwUBbWq7r0UsITK64U5EwM+29ZuRMIUaxZZaBmjtilOO/y2noyxXODn/pofkJU1b6Vls5/wskawKNtGvCHN2Jrj/mEmYEOs1cP1Ajtyi95jmt1WFAwaSREaKXYUoWKkg0kibxXVMkCkspXWW8ZAlZg3+I50az6UXmIIq+U+S4ahcuf6nux4=
- DOCTR_VERSIONS_MENU_DEBUG: true
- DOCTR_VERSIONS_MENU_VERSIONS: '''(<branches> != (master, rtd-theme)), (<releases>)[:-1], rtd-theme, (<releases>)[-1], master'''
- DOCTR_VERSIONS_MENU_LABEL: '''rtd-theme: v0.3.0 (rtd-theme)'''
- DOCTR_VERSIONS_MENU_LABEL: '''rtd-theme: v0.4.0 (rtd-theme)'''
- DOCTR_VERSIONS_MENU_WARNING: '''unreleased: (<branches> != rtd-theme), <local-releases>'''
addons:
apt_packages:
Expand Down
23 changes: 6 additions & 17 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import sys

import git
import sphinx_rtd_theme

import doctr_versions_menu

Expand Down Expand Up @@ -111,28 +112,16 @@ def iad_add_directive_header(self, sig):

# -- Options for HTML output ---------------------------------------------------

html_theme = "alabaster"
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# 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 = {
'github_user': 'goerz',
'github_repo': 'doctr_versions_menu',
'github_banner': True,
'logo_name': True,
'show_relbars': True,
'show_related': True,
}

html_sidebars = {
'**': ['globaltoc.html', 'sidebarhelp.html', 'searchbox.html'],
'index': [
'localtocindex.html',
'globaltocindex.html',
'sidebarhelp.html',
'searchbox.html',
],
'collapse_navigation': True,
'display_version': True,
'navigation_depth': 4,
}

# Add any paths that contain custom themes here, relative to this directory.
Expand Down

0 comments on commit 5ccb0ce

Please sign in to comment.