Don't write SSI-like comments.

Rename sidebar to sphinxsidebar so that reST sidebars are not confused.
This commit is contained in:
Georg Brandl 2008-05-23 13:54:50 +00:00
parent 85ab5bf4a4
commit 62b8028842
8 changed files with 48 additions and 43 deletions

View File

@ -22,6 +22,11 @@ Bugs fixed
* Handle project names containing spaces. * Handle project names containing spaces.
* Don't write SSI-like comments in HTML output.
* Rename the "sidebar" class to "sphinxsidebar" in order to stay different
from reST sidebars.
Release 0.3 (May 6, 2008) Release 0.3 (May 6, 2008)
========================= =========================

View File

@ -67,7 +67,7 @@ class HTMLTranslator(BaseTranslator):
self.body.append(self.starttag(node, 'dt')) self.body.append(self.starttag(node, 'dt'))
# anchor for per-desc interactive data # anchor for per-desc interactive data
if node.parent['desctype'] != 'describe' and node['ids'] and node['first']: if node.parent['desctype'] != 'describe' and node['ids'] and node['first']:
self.body.append('<!--#%s#-->' % node['ids'][0]) self.body.append('<!--[%s]-->' % node['ids'][0])
if node.parent['desctype'] in ('class', 'exception'): if node.parent['desctype'] in ('class', 'exception'):
self.body.append('%s ' % node.parent['desctype']) self.body.append('%s ' % node.parent['desctype'])
def depart_desc_signature(self, node): def depart_desc_signature(self, node):

View File

@ -31,11 +31,11 @@ div.body {
padding: 0 20px 30px 20px; padding: 0 20px 30px 20px;
} }
div.sidebarwrapper { div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px; padding: 10px 5px 0 10px;
} }
div.sidebar { div.sphinxsidebar {
float: left; float: left;
width: 230px; width: 230px;
margin-left: -100%; margin-left: -100%;
@ -92,7 +92,7 @@ div.related a {
} }
/* ::: TOC :::: */ /* ::: TOC :::: */
div.sidebar h3 { div.sphinxsidebar h3 {
font-family: 'Trebuchet MS', sans-serif; font-family: 'Trebuchet MS', sans-serif;
color: white; color: white;
font-size: 1.4em; font-size: 1.4em;
@ -101,7 +101,7 @@ div.sidebar h3 {
padding: 0; padding: 0;
} }
div.sidebar h4 { div.sphinxsidebar h4 {
font-family: 'Trebuchet MS', sans-serif; font-family: 'Trebuchet MS', sans-serif;
color: white; color: white;
font-size: 1.3em; font-size: 1.3em;
@ -110,41 +110,41 @@ div.sidebar h4 {
padding: 0; padding: 0;
} }
div.sidebar p { div.sphinxsidebar p {
color: white; color: white;
} }
div.sidebar p.topless { div.sphinxsidebar p.topless {
margin: 5px 10px 10px 10px; margin: 5px 10px 10px 10px;
} }
div.sidebar ul { div.sphinxsidebar ul {
margin: 10px; margin: 10px;
padding: 0; padding: 0;
list-style: none; list-style: none;
color: white; color: white;
} }
div.sidebar ul ul, div.sphinxsidebar ul ul,
div.sidebar ul.want-points { div.sphinxsidebar ul.want-points {
margin-left: 20px; margin-left: 20px;
list-style: square; list-style: square;
} }
div.sidebar ul ul { div.sphinxsidebar ul ul {
margin-top: 0; margin-top: 0;
margin-bottom: 0; margin-bottom: 0;
} }
div.sidebar a { div.sphinxsidebar a {
color: #98dbcc; color: #98dbcc;
} }
div.sidebar form { div.sphinxsidebar form {
margin-top: 10px; margin-top: 10px;
} }
div.sidebar input { div.sphinxsidebar input {
border: 1px solid #98dbcc; border: 1px solid #98dbcc;
font-family: sans-serif; font-family: sans-serif;
font-size: 1em; font-size: 1em;
@ -425,7 +425,7 @@ div#suggest-changes-box textarea {
/* :::: PREVIEW :::: */ /* :::: PREVIEW :::: */
div.preview { div.preview {
background-image: url(style/preview.png); background-image: url(style/preview.png);
padding: 0 20px 20px 20px; padding: 0 20px 20px 20px;
margin-bottom: 30px; margin-bottom: 30px;
@ -795,14 +795,14 @@ form.comment textarea {
/* :::: PRINT :::: */ /* :::: PRINT :::: */
@media print { @media print {
div.document, div.document,
div.documentwrapper, div.documentwrapper,
div.bodywrapper { div.bodywrapper {
margin: 0; margin: 0;
width : 100%; width : 100%;
} }
div.sidebar, div.sphinxsidebar,
div.related, div.related,
div.footer, div.footer,
div#comments div.new-comment-box, div#comments div.new-comment-box,

View File

@ -3,7 +3,7 @@
*/ */
div.sidebar { div.sphinxsidebar {
float: right; float: right;
} }

View File

@ -207,7 +207,7 @@ div.body a {
text-decoration: underline; text-decoration: underline;
} }
div.sidebar { div.sphinxsidebar {
margin: 0; margin: 0;
padding: 0.5em 15px 15px 0; padding: 0.5em 15px 15px 0;
width: 210px; width: 210px;
@ -216,7 +216,7 @@ div.sidebar {
/* margin-left: -100%; */ /* margin-left: -100%; */
} }
div.sidebar h4, div.sidebar h3 { div.sphinxsidebar h4, div.sphinxsidebar h3 {
margin: 1em 0 0.5em 0; margin: 1em 0 0.5em 0;
font-size: 0.9em; font-size: 0.9em;
padding: 0.1em 0 0.1em 0.5em; padding: 0.1em 0 0.1em 0.5em;
@ -225,7 +225,7 @@ div.sidebar h4, div.sidebar h3 {
background-color: #AFC1C4; background-color: #AFC1C4;
} }
div.sidebar ul { div.sphinxsidebar ul {
padding-left: 1.5em; padding-left: 1.5em;
margin-top: 7px; margin-top: 7px;
list-style: none; list-style: none;
@ -233,7 +233,7 @@ div.sidebar ul {
line-height: 130%; line-height: 130%;
} }
div.sidebar ul ul { div.sphinxsidebar ul ul {
list-style: square; list-style: square;
margin-left: 20px; margin-left: 20px;
} }
@ -316,29 +316,29 @@ div.pagination {
text-align: center; text-align: center;
} }
div.sidebar ul.toc { div.sphinxsidebar ul.toc {
margin: 1em 0 1em 0; margin: 1em 0 1em 0;
padding: 0 0 0 0.5em; padding: 0 0 0 0.5em;
list-style: none; list-style: none;
} }
div.sidebar ul.toc li { div.sphinxsidebar ul.toc li {
margin: 0.5em 0 0.5em 0; margin: 0.5em 0 0.5em 0;
font-size: 0.9em; font-size: 0.9em;
line-height: 130%; line-height: 130%;
} }
div.sidebar ul.toc li p { div.sphinxsidebar ul.toc li p {
margin: 0; margin: 0;
padding: 0; padding: 0;
} }
div.sidebar ul.toc ul { div.sphinxsidebar ul.toc ul {
margin: 0.2em 0 0.2em 0; margin: 0.2em 0 0.2em 0;
padding: 0 0 0 1.8em; padding: 0 0 0 1.8em;
} }
div.sidebar ul.toc ul li { div.sphinxsidebar ul.toc ul li {
padding: 0; padding: 0;
} }

View File

@ -1,8 +1,8 @@
/** /**
* Sphinx Doc Design -- Sticky Sidebar Overrides * Sphinx Doc Design -- Sticky sidebar Overrides
*/ */
div.sidebar { div.sphinxsidebar {
top: 30px; top: 30px;
left: 0px; left: 0px;
position: fixed; position: fixed;
@ -16,4 +16,4 @@ div.related {
div.documentwrapper { div.documentwrapper {
margin-top: 30px; margin-top: 30px;
} }

View File

@ -24,13 +24,13 @@ div.body {
padding: 0 20px 30px 20px; padding: 0 20px 30px 20px;
} }
div.sidebarwrapper { div.sphinxsidebarwrapper {
border: 1px solid #99ccff; border: 1px solid #99ccff;
padding: 10px; padding: 10px;
margin: 10px 15px 10px 0; margin: 10px 15px 10px 0;
} }
div.sidebar { div.sphinxsidebar {
float: right; float: right;
margin-left: -100%; margin-left: -100%;
width: 230px; width: 230px;
@ -78,30 +78,30 @@ div.related li.right {
} }
/* ::: SIDEBAR :::: */ /* ::: SIDEBAR :::: */
div.sidebar h3 { div.sphinxsidebar h3 {
margin: 0; margin: 0;
} }
div.sidebar h4 { div.sphinxsidebar h4 {
margin: 5px 0 0 0; margin: 5px 0 0 0;
} }
div.sidebar p.topless { div.sphinxsidebar p.topless {
margin: 5px 10px 10px 10px; margin: 5px 10px 10px 10px;
} }
div.sidebar ul { div.sphinxsidebar ul {
margin: 10px; margin: 10px;
margin-left: 15px; margin-left: 15px;
padding: 0; padding: 0;
} }
div.sidebar ul ul { div.sphinxsidebar ul ul {
margin-top: 0; margin-top: 0;
margin-bottom: 0; margin-bottom: 0;
} }
div.sidebar form { div.sphinxsidebar form {
margin-top: 10px; margin-top: 10px;
} }
@ -350,7 +350,7 @@ div#suggest-changes-box textarea {
/* :::: PREVIEW :::: */ /* :::: PREVIEW :::: */
div.preview { div.preview {
background-image: url(style/preview.png); background-image: url(style/preview.png);
padding: 0 20px 20px 20px; padding: 0 20px 20px 20px;
margin-bottom: 30px; margin-bottom: 30px;
@ -690,7 +690,7 @@ form.comment textarea {
margin: 0; margin: 0;
} }
div.sidebar, div.sphinxsidebar,
div.related, div.related,
div.footer, div.footer,
div#comments div.new-comment-box, div#comments div.new-comment-box,

View File

@ -34,8 +34,8 @@
{%- endmacro %} {%- endmacro %}
{%- macro sidebar %} {%- macro sidebar %}
{%- if builder != 'htmlhelp' %} {%- if builder != 'htmlhelp' %}
<div class="sidebar"> <div class="sphinxsidebar">
<div class="sidebarwrapper"> <div class="sphinxsidebarwrapper">
{%- block sidebarlogo %} {%- block sidebarlogo %}
{%- if logo %} {%- if logo %}
<p class="logo"><img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/></p> <p class="logo"><img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/></p>