e5f371a08808 initial-docs

docs: more doc structure and themeing
[view raw] [browse files]
author Steve Losh <steve@stevelosh.com>
date Mon, 14 Jun 2010 22:34:57 -0400
parents 68b8187e26b1
children cadaa12baca9
branches/tags initial-docs
files docs/api.rst docs/dev.rst docs/hacking.rst docs/hgreview/static/review.less docs/index.rst

Changes

--- a/docs/api.rst	Mon Jun 14 22:23:30 2010 -0400
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,11 +0,0 @@
-API
-===
-
-Data Repository
----------------
-
-File Formats
-------------
-
-Python API
-----------
--- a/docs/dev.rst	Mon Jun 14 22:23:30 2010 -0400
+++ b/docs/dev.rst	Mon Jun 14 22:34:57 2010 -0400
@@ -0,0 +1,11 @@
+API
+===
+
+Data Repository
+---------------
+
+File Formats
+------------
+
+Python API
+----------
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/hacking.rst	Mon Jun 14 22:34:57 2010 -0400
@@ -0,0 +1,9 @@
+Hacking hg-review
+=================
+
+Layout
+------
+
+Testing
+-------
+
--- a/docs/hgreview/static/review.less	Mon Jun 14 22:23:30 2010 -0400
+++ b/docs/hgreview/static/review.less	Mon Jun 14 22:34:57 2010 -0400
@@ -5,6 +5,7 @@
 
 @font-normal: Georgia, serif;
 @font-mono: Monaco, Consolas, "Courier New", monospace;
+@content-width: 800px;
 
 .border-radius(@radius) {
     -webkit-border-radius: @radius;
@@ -34,6 +35,17 @@
     h1 {
         letter-spacing: 1px;
     }
+    ul {
+        list-style-type: none;
+        
+        li {
+            margin-left: 0;
+
+            li {
+                margin-left: 2em;
+            }
+        }
+    }
 }
 .related {
     display: none;
@@ -43,7 +55,7 @@
     border: 1px solid @c-cream;
     margin: 25px auto 0px;
     padding: 0px 00px;
-    width: 800px;
+    width: @content-width;
 
     .documentwrapper {
         .border-radius(8px);
@@ -62,15 +74,27 @@
                 border: 1px solid @c-cream;
                 background-color: lighten(@c-soft-cream, 3%);
                 font-size: 13px;
+                font-family: @font-mono;
                 line-height: 24px;
-                margin-bottom: 37px;
-                margin-top: -15px;
+                margin-bottom: 36px;
+                margin-top: -14px;
                 margin-left: 24px;
                 padding: 0px 8px;
             }
-        }
-        *:last-child {
-            margin-bottom: 0;
+            span.pre {
+                background-color: lighten(@c-soft-cream, 3%);
+                font-size: 13px;
+                font-family: @font-mono;
+                line-height: 24px;
+            }
+            ul {
+                span.pre {
+                    background-color: inherit;
+                }
+            }
+            a em {
+                font-style: normal;
+            }
         }
     }
     .sphinxsidebar {
@@ -79,17 +103,6 @@
         width: 220px;
         padding: 20px 20px;
 
-        ul {
-            list-style-type: none;
-            
-            li {
-                margin-left: 0;
-
-                li {
-                    margin-left: 2em;
-                }
-            }
-        }
         #searchbox {
             h3 {
                 margin-bottom: 8px;
@@ -115,8 +128,9 @@
     clear: both;
 }
 .footer {
-    width: 900px;
+    width: @content-width;
     margin: 8px auto 40px;
+    padding-right: 10px;
     text-align: right;
     font-style: italic;
 }
--- a/docs/index.rst	Mon Jun 14 22:23:30 2010 -0400
+++ b/docs/index.rst	Mon Jun 14 22:34:57 2010 -0400
@@ -44,6 +44,9 @@
 User's Guide
 ------------
 
+If you want to use hg-review for anything more than some simple poking around,
+this is the place to start.
+
 .. toctree::
    :maxdepth: 2
 
@@ -55,15 +58,12 @@
 Developer's Guide
 -----------------
 
+If you want to integrate hg-review with your own application or Mercurial
+extension, this is what you need to know.
+
 .. toctree::
    :maxdepth: 2
 
-   api
-
-Indices and tables
-------------------
+   dev
+   hacking
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-