Skip to content

Commit c546e18

Browse files
committed
Updated the style of python docs
Included my revised conf.py and the stylesheet to use instead of the default (to match ponydocs).
1 parent 8373a1a commit c546e18

File tree

2 files changed

+77
-8
lines changed

2 files changed

+77
-8
lines changed

docs/CSS/epub.css

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
/* Page background color */
2+
body { background: transparent }
3+
4+
/* Headings */
5+
h1 { font-size: 145% }
6+
7+
body {
8+
font-family: Arial, sans-serif;
9+
color: #555;
10+
font-size: 13px;
11+
line-height: 18px;
12+
margin:0 auto;
13+
padding-left:5px;
14+
padding-right:5px;
15+
}
16+
17+
pre {font-weight: bold}
18+
19+
table {
20+
border-width: 0px;
21+
border-spacing: 0px;
22+
border-style: outset;
23+
border-color: gray;
24+
border-collapse: collapse;
25+
background-color: white;
26+
/*margin-top:15px; */
27+
margin-bottom: 15px;
28+
}
29+
30+
th {
31+
border-width: 0px;
32+
padding: 2px 6px 1px 6px;
33+
border-style: inset;
34+
border-color: #e2e2e2;
35+
background-color: #eeeeee;
36+
text-align: left;
37+
}
38+
39+
td {
40+
border-width: 0px;
41+
padding: 2px 6px 1px 6px;
42+
border-style: inset;
43+
border-color: #e2e2e2;
44+
background-color: white;
45+
}
46+
47+
a {
48+
color: rgb(8, 89, 130);
49+
text-decoration: none;
50+
}
51+
52+
/* Font used in left-hand frame lists */
53+
.FrameTitleFont { font-size: 100%; font-family: Arial, sans-serif; color:#000000 }
54+
.FrameHeadingFont { font-size: 100%; font-family: Arial, sans-serif; color:#000000 }
55+
.FrameItemFont { font-size: 100%; font-family: Arial, sans-serif; color:#000000 }
56+
57+
58+
/* Navigation bar fonts and colors */
59+
.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */
60+
.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */
61+
.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;}
62+
.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;}
63+
64+
.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000}
65+
.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000}

docs/conf.py

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343

4444
# General information about the project.
4545
project = u'Splunk Python SDK'
46-
copyright = u'2012, Splunk Inc.'
46+
copyright = u'2012, Splunk Inc'
4747

4848
# The version info for the project you're documenting, acts as replacement for
4949
# |version| and |release|, also used in various other places throughout the
@@ -95,7 +95,7 @@
9595
# a list of builtin themes.
9696

9797
# agogo, default, epub, haiku, nature, pyramid, scrolls, sphinxdoc, traditional
98-
html_theme = 'haiku'
98+
html_theme = 'epub'
9999

100100
# Theme options are theme-specific and customize the look and feel of a theme
101101
# further. For a list of options available for each theme, see the
@@ -107,10 +107,10 @@
107107

108108
# The name for this set of Sphinx documents. If None, it defaults to
109109
# "<project> v<release> documentation".
110-
#html_title = None
110+
html_title = "Splunk Python SDK Reference"
111111

112112
# A shorter title for the navigation bar. Default is the same as html_title.
113-
#html_short_title = None
113+
#html_short_title = "Splunk Python SDK Reference"
114114

115115
# The name of an image file (relative to this directory) to place at the top
116116
# of the sidebar.
@@ -124,7 +124,8 @@
124124
# Add any paths that contain custom static files (such as style sheets) here,
125125
# relative to this directory. They are copied after the builtin static files,
126126
# so a file named "default.css" will overwrite the builtin "default.css".
127-
html_static_path = ['_static']
127+
html_static_path = ['css']
128+
128129

129130
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
130131
# using the given strftime format.
@@ -135,7 +136,10 @@
135136
#html_use_smartypants = True
136137

137138
# Custom sidebar templates, maps document names to template names.
138-
#html_sidebars = {}
139+
#html_sidebars = {
140+
html_sidebars = {
141+
'**': ['localtoc.html', 'globaltoc.html', 'searchbox.html'],
142+
}
139143

140144
# Additional templates that should be rendered to pages, maps page names to
141145
# template names.
@@ -154,10 +158,10 @@
154158
#html_show_sourcelink = True
155159

156160
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
157-
#html_show_sphinx = True
161+
#html_show_sphinx = False
158162

159163
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
160-
#html_show_copyright = True
164+
#html_show_copyright = False
161165

162166
# If true, an OpenSearch description file will be output, and all pages will
163167
# contain a <link> tag referring to it. The value of this option must be the

0 commit comments

Comments
 (0)