aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/source/_static/img/logo_32x32.pngbin0 -> 2097 bytes
-rw-r--r--docs/source/_static/rambutan-docs.css89
-rw-r--r--docs/source/_templates/layout.html18
-rw-r--r--docs/source/_templates/sidebarresources.html8
-rw-r--r--docs/source/conf.py9
5 files changed, 81 insertions, 43 deletions
diff --git a/docs/source/_static/img/logo_32x32.png b/docs/source/_static/img/logo_32x32.png
new file mode 100644
index 0000000..bacdd6f
--- /dev/null
+++ b/docs/source/_static/img/logo_32x32.png
Binary files differ
diff --git a/docs/source/_static/rambutan-docs.css b/docs/source/_static/rambutan-docs.css
index e5b00ae..7f7e0f2 100644
--- a/docs/source/_static/rambutan-docs.css
+++ b/docs/source/_static/rambutan-docs.css
@@ -3,6 +3,7 @@
/* TODO: http://practicaltypography.com/rules-and-borders.html */
+/* General page styling */
body {
font-family: "Crimson Text", serif;
font-size: 16px;
@@ -14,21 +15,6 @@ body {
color: rgb(72, 72, 72);
}
-.sphinxsidebar {
- padding-top: 10em;
- opacity: 0.65;
- font-size: 0.9rem;
-}
-
-.sphinxsidebar:hover {
- opacity: 0.9;
-}
-
-.sphinxsidebar .search input {
- padding-left: 0.25rem;
- margin-bottom: 2em;
-}
-
h1, h2, h3, h4, h5, h6 {
color: #000;
font-family: "Open Sans", "Helvetica", sans-serif;
@@ -41,15 +27,25 @@ h4 { font-size: 0.9em; font-weight: normal; }
h5 { font-size: 0.9em; font-weight: normal; }
header h1 {
+ opacity: 0.65;
margin-top: 0.3em;
font-size: 1.2em;
- opacity: 0.65;
+ margin-left: 240px;
+ font-family: "Open Sans", "Helvetica", sans-serif;
+ font-weight: bold;
+ text-transform: uppercase;
+ font-variant: small-caps;
+ font-weight: normal;
}
header h1:hover {
opacity: 0.9;
}
+header h1 a, header h1 a:visited {
+ color: #000;
+}
+
.rubric {
text-align: center;
text-transform: uppercase;
@@ -70,21 +66,6 @@ footer#pagefooter, footer#pagefooter a {
.contents .topic-title {
font-weight: normal;
}
-
-body > header h1 a, body > header h1 a:visited {
- color: #000;
- margin-left: 240px;
- font-family: "Open Sans", "Helvetica", sans-serif;
- font-weight: bold;
- text-transform: uppercase;
- font-variant: small-caps;
- font-weight: normal;
-}
-
-.sphinxsidebar h3 a {
- color: #222;
-}
-
pre, tt {
font-family: "Source Code Pro", "Monaco", "Consolas", "Lucida Console", monospace;
}
@@ -102,6 +83,25 @@ a tt {
font-weight: normal;
}
+.sphinxsidebar {
+ padding-top: 10em;
+ opacity: 0.65;
+ font-size: 0.9rem;
+}
+
+.sphinxsidebar:hover {
+ opacity: 0.9;
+}
+
+.sphinxsidebar .search input {
+ padding-left: 0.25rem;
+ margin-bottom: 2em;
+}
+
+.sphinxsidebar h3 a {
+ color: #222;
+}
+
.highlight pre {
color: #ccc;
background-color: #333;
@@ -114,19 +114,32 @@ a tt {
line-height: 120%;
}
-div.admondition, div.topic, div.warning, div.note {
- border-left: none;
- border-right: none;
+a:hover {
+ text-decoration: none;
}
-div.note, div.topic {
- background-color: #f4f4f4;
+tt.descname {
+ font-size: 0.8em;
+}
+
+dl.function > dt, dl.class > dt, dl.method > dt, dl.attribute > dt, dl.data > dt, dl.classmethod > dt, dl.enum > dt {
+ margin-bottom: 0.5em;
+ background: #f4f4f4;
+}
+
+dl li > p {
+ display: inline;
}
.related.bottom {
margin-top: 2em;
}
-a:hover {
- text-decoration: none;
+div.admondition, div.topic, div.warning, div.note {
+ border-left: none;
+ border-right: none;
+}
+
+div.note, div.topic {
+ background-color: #f4f4f4;
}
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html
new file mode 100644
index 0000000..994ad53
--- /dev/null
+++ b/docs/source/_templates/layout.html
@@ -0,0 +1,18 @@
+{% extends "!layout.html" %}
+
+{# TODO: this block is broken under Sphinx better theme? #}
+{% block rootrellink %}
+ <li><a href="http://rambutan.cc/">
+ <img width="16px" src="_static/img/logo_32x32.png"></img>
+ rambutan.cc
+ </a>&middot;</li>
+ <li><a href="http://docs.rambutan.cc">Project Docs</a>{{ reldelim1 }}</li>
+ {{ super() }}
+{% endblock %}
+
+{% block header %}
+ <header id="pageheader"><h1>
+ <a href="http://docs.rambutan.cc">Rambutan Documentation:</a>
+ <a href="{{ pathto(master_doc) }} ">{{ shorttitle }} {{ release}}</a>
+ </h1></header>
+{% endblock %}
diff --git a/docs/source/_templates/sidebarresources.html b/docs/source/_templates/sidebarresources.html
new file mode 100644
index 0000000..ff82669
--- /dev/null
+++ b/docs/source/_templates/sidebarresources.html
@@ -0,0 +1,8 @@
+<h3>Project Resources</h3>
+
+<ul>
+ <li><a href="http://rambutan.cc/">Homepage</a></li>
+ <li><a href="https://github.com/rambutan32/">Code on Github</a></li>
+ <li><a href="http://forums.rambutan.cc/">Discussion Forums</a></li>
+ <li><a href="irc://irc.oftc.net/rambutan">IRC: #rambutan on oftc.net</a></li>
+</ul>
diff --git a/docs/source/conf.py b/docs/source/conf.py
index c4d4559..5c5dc0b 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -51,7 +51,7 @@ master_doc = 'contents'
# General information about the project.
project = u'librambutan'
-copyright = u'2010, 2011, LeafLabs, LLC. 2014 Various Contributors.'
+copyright = u'2010, 2011, LeafLabs, LLC. 2014 Various Contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -132,10 +132,9 @@ html_theme_options = {
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = project + ' v' + release
-html_title = "librambutan Documentation"
# A shorter title for the navigation bar. Default is the same as html_title.
-html_short_title = 'Index'
+html_short_title = 'librambutan'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
@@ -144,7 +143,7 @@ html_short_title = 'Index'
# 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
# pixels large.
-#html_favicon = '_static/img/round_logo_32x32.ico'
+html_favicon = '_static/img/logo_32x32.png'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
@@ -161,7 +160,7 @@ html_last_updated_fmt = '%b %d, %Y'
# Custom sidebar templates, maps document names to template names.
html_sidebars = {
- '**': ['globaltoc.html', 'searchbox.html'],
+ '**': ['globaltoc.html', 'sidebarresources.html', 'searchbox.html'],
}
# Additional templates that should be rendered to pages, maps page names to
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-23 21:12:21 +0000