68b8187e26b1 initial-docs

docs: start a theme
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Mon, 14 Jun 2010 22:23:30 -0400
parents 5d26872c0260
children e5f371a08808
branches/tags initial-docs
files docs/conf.py docs/hgreview/static/aal.css docs/hgreview/static/review.css docs/hgreview/static/review.less docs/hgreview/theme.conf docs/index.rst

Changes

--- a/docs/conf.py	Mon Jun 14 21:09:16 2010 -0400
+++ b/docs/conf.py	Mon Jun 14 22:23:30 2010 -0400
@@ -91,7 +91,8 @@
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'default'
+html_theme_path = ['.']
+html_theme = 'hgreview'
 
 # 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
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/hgreview/static/aal.css	Mon Jun 14 22:23:30 2010 -0400
@@ -0,0 +1,99 @@
+/* 
+  aardvark.legs by Anatoli Papirovski - http://fecklessmind.com/
+  Licensed under the MIT license. http://www.opensource.org/licenses/mit-license.php
+*/
+
+/* 
+  Reset first. Modified version of Eric Meyer and Paul Chaplin reset 
+  from http://meyerweb.com/eric/tools/css/reset/ 
+*/
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, font, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+header, nav, section, article, aside, footer
+{border: 0; margin: 0; outline: 0; padding: 0; background: transparent; vertical-align: baseline;}
+
+blockquote, q {quotes: none;}
+blockquote:before,blockquote:after,q:before,q:after {content: ''; content: none;}
+
+header, nav, section, article, aside, footer {display: block;}
+
+/* Basic styles */
+body {background: #fff; color: #111; font: 1em/1.5em "Helvetica Neue", Helvetica, Arial, "Liberation Sans", "Bitstream Vera Sans", sans-serif;}
+html>body {font-size: 16px;}
+
+img {display: inline-block; vertical-align: bottom;}
+
+h1,h2,h3,h4,h5,h6,strong,b,dt,th {font-weight: 700;}
+address,cite,em,i,caption,dfn,var {font-style: italic;}
+
+h1 {margin: 0 0 0.75em; font-size: 2em;}
+h2 {margin: 0 0 1em; font-size: 1.5em;}
+h3 {margin: 0 0 1.286em; font-size: 1.167em;}
+h4 {margin: 0 0 1.5em; font-size: 1em;}
+h5 {margin: 0 0 1.8em; font-size: .834em;}
+h6 {margin: 0 0 2em; font-size: .75em;}
+
+p,ul,ol,dl,blockquote,pre {margin: 0 0 1.5em;}
+
+li ul,li ol {margin: 0;}
+ul {list-style: outside disc;}
+ol {list-style: outside decimal;}
+li {margin: 0 0 0 2em;}
+dd {padding-left: 1.5em;}
+blockquote {padding: 0 1.5em;}
+
+a {text-decoration: underline;}
+a:hover {text-decoration: none;}
+abbr,acronym {border-bottom: 1px dotted; cursor: help;}
+del {text-decoration: line-through;}
+ins {text-decoration: overline;}
+sub {font-size: .834em; line-height: 1em; vertical-align: sub;}
+sup {font-size: .834em; line-height: 1em; vertical-align: super;}
+
+tt,code,kbd,samp,pre {font-size: 1em; font-family: Consolas, Monaco, "Courier New", Courier, monospace;}
+
+/* Table styles */
+table {border-collapse: collapse; border-spacing: 0; margin: 0 0 1.5em;}
+caption {text-align: left;}
+th, td {padding: .25em .5em;}
+tbody td, tbody th {border: 1px solid #000;}
+tfoot {font-style: italic;}
+
+/* Form styles */
+fieldset {clear: both;}
+legend {padding: 0 0 1.286em; font-size: 1.167em; font-weight: 700;}
+fieldset fieldset legend {padding: 0 0 1.5em; font-size: 1em;}
+* html legend {margin-left: -7px;}
+*+html legend {margin-left: -7px;}
+
+form .field, form .buttons {clear: both; margin: 0 0 1.5em;}
+form .field label {display: block;}
+form ul.fields li {list-style-type: none; margin: 0;}
+form ul.inline li, form ul.inline label {display: inline;}
+form ul.inline li {padding: 0 .75em 0 0;}
+
+input.radio, input.checkbox {vertical-align: top;}
+label, button, input.submit, input.image {cursor: pointer;}
+* html input.radio, * html input.checkbox {vertical-align: middle;}
+*+html input.radio, *+html input.checkbox {vertical-align: middle;}
+
+textarea {overflow: auto;}
+input.text, input.password, textarea, select {margin: 0; font: 1em/1.3 Helvetica, Arial, "Liberation Sans", "Bitstream Vera Sans", sans-serif; vertical-align: baseline;}
+input.text, input.password, textarea {border: 1px solid #444; border-bottom-color: #666; border-right-color: #666; padding: 2px;}
+
+* html button {margin: 0 .34em 0 0;}
+*+html button {margin: 0 .34em 0 0;}
+
+form.horizontal .field {padding-left: 150px;}
+form.horizontal .field label {display: inline; float: left; width: 140px; margin-left: -150px;}
+
+/* Useful classes */
+img.left {display: inline; float: left; margin: 0 1.5em .75em 0;}
+img.right {display: inline; float: right; margin: 0 0 .75em .75em;}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/hgreview/static/review.css	Mon Jun 14 22:23:30 2010 -0400
@@ -0,0 +1,34 @@
+@import url("aal.css");
+body, html {
+  background-color: #fcfcfc;
+  font-family: Georgia, serif;
+  color: #111;
+}
+h1, h2 {
+  font-weight: normal;
+}
+h1 {
+  letter-spacing: 1px;
+}
+a {
+  color: #b6410c;
+  text-decoration: none;
+}
+a:hover {
+  text-decoration: none;
+}
+.document .sphinxsidebar {
+  float: left;
+}
+.related {
+  display: none;
+}
+.bodywrapper {
+  float: left;
+}
+.document {
+  margin: 30px auto 0px;
+}
+.clearer {
+  clear: both;
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/hgreview/static/review.less	Mon Jun 14 22:23:30 2010 -0400
@@ -0,0 +1,122 @@
+@import url("aal.css");
+
+@c-cream: #edecc7;
+@c-soft-cream: lighten(@c-cream, 10%);
+
+@font-normal: Georgia, serif;
+@font-mono: Monaco, Consolas, "Courier New", monospace;
+
+.border-radius(@radius) {
+    -webkit-border-radius: @radius;
+    -moz-border-radius: @radius;
+    border-radius: @radius;
+}
+
+body, html {
+    background-color: @c-soft-cream;
+    font-family: Georgia, serif;
+    color: #222;
+
+    a {
+        color: #b6410c;
+        text-decoration: none;
+
+        &:hover {
+            text-decoration: underline;
+        }
+        &.headerlink {
+            display: none;
+        }
+    }
+    h1, h2, h3, h4, h5, h6 {
+        font-weight: normal;
+    }
+    h1 {
+        letter-spacing: 1px;
+    }
+}
+.related {
+    display: none;
+}
+.document {
+    .border-radius(8px);
+    border: 1px solid @c-cream;
+    margin: 25px auto 0px;
+    padding: 0px 00px;
+    width: 800px;
+
+    .documentwrapper {
+        .border-radius(8px);
+        background-color: lighten(@c-soft-cream, 3%);
+        float: left;
+        width: 100%;
+
+        .bodywrapper {
+            .border-radius(8px);
+            background-color: #fefefe;
+            margin-left: 230px;
+            border-left: 1px solid @c-cream;
+            padding: 20px 30px;
+
+            div pre {
+                border: 1px solid @c-cream;
+                background-color: lighten(@c-soft-cream, 3%);
+                font-size: 13px;
+                line-height: 24px;
+                margin-bottom: 37px;
+                margin-top: -15px;
+                margin-left: 24px;
+                padding: 0px 8px;
+            }
+        }
+        *:last-child {
+            margin-bottom: 0;
+        }
+    }
+    .sphinxsidebar {
+        float: left;
+        margin-left: -100%;
+        width: 220px;
+        padding: 20px 20px;
+
+        ul {
+            list-style-type: none;
+            
+            li {
+                margin-left: 0;
+
+                li {
+                    margin-left: 2em;
+                }
+            }
+        }
+        #searchbox {
+            h3 {
+                margin-bottom: 8px;
+            }
+            form {
+                input:nth-child(1) {
+                    border: 1px solid #999;
+                    font-size: 16px;
+                }
+                input:nth-child(2) {
+                    display: block;
+                    margin-top: 6px;
+                    width: 60px;
+                }
+            }
+            .searchtip {
+                display: none;
+            }
+        }
+    }
+}
+.clearer {
+    clear: both;
+}
+.footer {
+    width: 900px;
+    margin: 8px auto 40px;
+    text-align: right;
+    font-style: italic;
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/hgreview/theme.conf	Mon Jun 14 22:23:30 2010 -0400
@@ -0,0 +1,5 @@
+[theme]
+inherit = basic
+stylesheet = review.css
+pygments_style = none
+
--- a/docs/index.rst	Mon Jun 14 21:09:16 2010 -0400
+++ b/docs/index.rst	Mon Jun 14 22:23:30 2010 -0400
@@ -25,7 +25,7 @@
     review = [path to]/hg-review/review/
 
 Now you need a repository that has code review enabled.  Luckily, you've
-already got one -- hg-review uses itself for code review.
+already got one -- hg-review uses itself for code review. 
 
 ``cd`` into the directory you cloned hg-review to and initialize the review
 data::