forked from ryan-roemer/sphinx-bootstrap-theme
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy paththeme.conf
65 lines (52 loc) · 1.82 KB
/
theme.conf
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# Bootstrap Theme
[theme]
inherit = basic
stylesheet = bootstrap-sphinx.css
pygments_style = tango
# The sphinx bootstrap theme includes information typically presented in a
# theme's sidebar in the navbar, so these are disabled by default.
# Users can override this with `html_sidebars` in their conf.py.
sidebars =
# Configurable options.
[options]
# Navigation bar title. (Default: ``project`` value)
navbar_title =
# Tab name for entire site. (Default: "Site")
navbar_site_name = Site
# A list of tuples containting pages to link to. The value should be
# in the form [(name, page), ..]
navbar_links =
# Render the next and previous page links in navbar. (Default: true)
navbar_sidebarrel = true
# Render the current pages TOC in the navbar. (Default: true)
navbar_pagenav = true
# Tab name for the current pages TOC. (Default: "Page")
navbar_pagenav_name = Page
# Global TOC depth for "site" navbar tab. (Default: 1)
# Switching to -1 shows all levels.
globaltoc_depth = 1
# Include hidden TOCs in Site navbar?
#
# Note: If this is "false", you cannot have mixed ``:hidden:`` and
# non-hidden ``toctree`` directives in the same page, or else the build
# will break.
#
# Values: "true" (default) or "false"
globaltoc_includehidden = true
# HTML navbar class (Default: "navbar") to attach to <div> element.
# For black navbar, do "navbar navbar-inverse"
navbar_class = navbar
# Fix navigation bar to top of page?
# Values: "true" (default) or "false"
navbar_fixed_top = true
# Location of link to source.
# Options are "nav" (default), "footer" or anything else to exclude.
source_link_position = nav
# Bootswatch (http://bootswatch.com/) theme.
#
# Options are nothing (default) or the name of a valid theme such as
# "cosmo" or "sandstone".
bootswatch_theme =
# Switch Bootstrap version?
# Values: "3" (default) or "2"
bootstrap_version = 3