[Checkins] SVN: buildout-website/trunk/ Finished full rework of styling, from a hodgepodge of changes to a .css file
Jeff Rush
jrush at taupro.com
Wed Apr 1 18:51:47 EDT 2009
Log message for revision 98780:
Finished full rework of styling, from a hodgepodge of changes to a .css file
into the new Sphinx "theme" setup, for easier reusability. Also created an
icon to represent the Buildout software, and a silly favicon for the buildout website.
I'm also providing the original artwork formats under artwork/ so that others
can rework any graphics they feel they can do better.
Changed:
A buildout-website/trunk/artwork/
A buildout-website/trunk/artwork/GraphicsWorksheet.svg
A buildout-website/trunk/artwork/hammer-B-2.pnm
A buildout-website/trunk/artwork/hammer-B.png
A buildout-website/trunk/artwork/hammer-B.pnm
A buildout-website/trunk/artwork/hammer-foot-2.pnm
A buildout-website/trunk/artwork/hammer-foot.png
A buildout-website/trunk/artwork/hammer-foot.pnm
A buildout-website/trunk/artwork/pencil-cross-hammer.png
A buildout-website/trunk/artwork/pencil-cross-hammer.pnm
U buildout-website/trunk/source/_static/default.css
A buildout-website/trunk/source/_static/hammer-B.ico
A buildout-website/trunk/source/_static/hammer-foot.ico
A buildout-website/trunk/source/_static/pencil-cross-hammer.ico
A buildout-website/trunk/source/buildout_theme/
A buildout-website/trunk/source/buildout_theme/static/
A buildout-website/trunk/source/buildout_theme/static/blueprint.jpg
A buildout-website/trunk/source/buildout_theme/static/buildout-logo.png
A buildout-website/trunk/source/buildout_theme/static/buildout.css_t
A buildout-website/trunk/source/buildout_theme/theme.conf
U buildout-website/trunk/source/conf.py
U buildout-website/trunk/source/docs/dirstruct.rst
A buildout-website/trunk/source/docs/usecase_singlemod.rst
U buildout-website/trunk/source/index.rst
-=-
Added: buildout-website/trunk/artwork/GraphicsWorksheet.svg
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/artwork/GraphicsWorksheet.svg
___________________________________________________________________
Added: svn:mime-type
+ image/svg+xml
Added: buildout-website/trunk/artwork/hammer-B-2.pnm
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/artwork/hammer-B-2.pnm
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: buildout-website/trunk/artwork/hammer-B.png
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/artwork/hammer-B.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Added: buildout-website/trunk/artwork/hammer-B.pnm
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/artwork/hammer-B.pnm
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: buildout-website/trunk/artwork/hammer-foot-2.pnm
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/artwork/hammer-foot-2.pnm
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: buildout-website/trunk/artwork/hammer-foot.png
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/artwork/hammer-foot.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Added: buildout-website/trunk/artwork/hammer-foot.pnm
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/artwork/hammer-foot.pnm
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: buildout-website/trunk/artwork/pencil-cross-hammer.png
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/artwork/pencil-cross-hammer.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Added: buildout-website/trunk/artwork/pencil-cross-hammer.pnm
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/artwork/pencil-cross-hammer.pnm
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Modified: buildout-website/trunk/source/_static/default.css
===================================================================
--- buildout-website/trunk/source/_static/default.css 2009-04-01 22:47:29 UTC (rev 98779)
+++ buildout-website/trunk/source/_static/default.css 2009-04-01 22:51:46 UTC (rev 98780)
@@ -1,6 +1,6 @@
/**
- * Sphinx stylesheet -- default theme
- * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ * Sphinx stylesheet -- buildout theme
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*/
@import url("basic.css");
@@ -8,9 +8,9 @@
/* -- page layout ----------------------------------------------------------- */
body {
- font-family: sans-serif;
+ font-family: {{ theme_bodyfont }};
font-size: 100%;
- background-color: #11303d;
+ background-color: {{ theme_footerbgcolor }};
color: #000;
margin: 0;
padding: 0;
@@ -38,8 +38,8 @@
text-decoration: underline;
}
-div.related {
- background-color: #133f52;
+div.related { /* horizontal bar across the top */
+ background-color: #272D7B /* was #133f52 */;
line-height: 30px;
color: #ffffff;
}
@@ -52,65 +52,85 @@
}
div.sphinxsidebar h3 {
- font-family: 'Trebuchet MS', sans-serif;
- color: #ffffff;
- font-size: 1.4em;
- font-weight: normal;
- margin: 0;
- padding: 0;
+ font-family: 'Trebuchet MS', sans-serif;
+ font-size: 1.2em;
+ font-weight: normal;
+
+ color: #ffffff;
+ margin: 0;
+
+ background-color: #272D7B; /* blueprint blue */
+ padding: 4px 4px 4px 4px;
+
+ -moz-border-radius: 5px;
+ -webkit-border-radius: 5px;
+ border: 2px solid #878DDB;
}
div.sphinxsidebar h3 a {
- color: #ffffff;
+ color: #ffffff;
}
div.sphinxsidebar h4 {
- font-family: 'Trebuchet MS', sans-serif;
- color: #ffffff;
- font-size: 1.3em;
- font-weight: normal;
- margin: 5px 0 0 0;
- padding: 0;
+ font-family: 'Trebuchet MS', sans-serif;
+ color: #ffffff;
+ background-color: #272D7B; /* blueprint blue */
+ font-size: 1.3em;
+ font-weight: normal;
+ margin: 5px 0 0 0;
+ padding: 4px 4px 4px 4px;
+ -moz-border-radius: 5px;
+ -webkit-border-radius: 5px;
+ border: 2px solid #878DDB;
}
div.sphinxsidebar p {
- color: #ffffff;
+ color: #ffffff;
}
div.sphinxsidebar p.topless {
- margin: 5px 10px 10px 10px;
+ margin: 5px 10px 10px 10px;
}
div.sphinxsidebar ul {
- margin: 10px;
- padding: 0;
- color: #ffffff;
+ margin: 10px;
+ padding: 0;
+ color: #ffffff;
}
div.sphinxsidebar a {
- color: #98dbcc;
+ color: #B8EBFC /*#98dbcc*/;
+ background-color: #272D7B; /* blueprint blue */
+ padding: 4px 4px 4px 4px;
+ font-size: 1.2em;
+ font-weight: bold;
}
+div.sphinxsidebar a:hover {
+ color: white;
+ text-decoration: none;
+}
+
div.sphinxsidebar input {
- border: 1px solid #98dbcc;
- font-family: sans-serif;
- font-size: 1em;
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
}
/* -- body styles ----------------------------------------------------------- */
a {
- color: #355f7c;
- text-decoration: none;
+ color: #355f7c;
+ text-decoration: none;
}
a:hover {
- text-decoration: underline;
+ text-decoration: underline;
}
div.body p, div.body dd, div.body li {
- text-align: justify;
- line-height: 130%;
+ text-align: justify;
+ line-height: 130%;
}
div.body h1,
@@ -136,75 +156,75 @@
div.body h6 { font-size: 100%; }
a.headerlink {
- color: #c60f0f;
- font-size: 0.8em;
- padding: 0 4px 0 4px;
- text-decoration: none;
+ color: #c60f0f;
+ font-size: 0.8em;
+ padding: 0 4px 0 4px;
+ text-decoration: none;
}
a.headerlink:hover {
- background-color: #c60f0f;
- color: white;
+ background-color: #c60f0f;
+ color: white;
}
div.body p, div.body dd, div.body li {
- text-align: justify;
- line-height: 130%;
+ text-align: justify;
+ line-height: 130%;
}
div.admonition p.admonition-title + p {
- display: inline;
+ display: inline;
}
div.note {
- background-color: #eee;
- border: 1px solid #ccc;
+ background-color: #eee;
+ border: 1px solid #ccc;
}
div.seealso {
- background-color: #ffc;
- border: 1px solid #ff6;
+ background-color: #ffc;
+ border: 1px solid #ff6;
}
div.topic {
- background-color: #eee;
+ background-color: #eee;
}
div.warning {
- background-color: #ffe4e4;
- border: 1px solid #f66;
+ background-color: #ffe4e4;
+ border: 1px solid #f66;
}
p.admonition-title {
- display: inline;
+ display: inline;
}
p.admonition-title:after {
- content: ":";
+ content: ":";
}
pre {
- padding: 5px;
- background-color: #eeffcc;
- color: #333333;
- line-height: 120%;
- border: 1px solid #ac9;
- border-left: none;
- border-right: none;
+ padding: 5px;
+ background-color: #eeffcc;
+ color: #333333;
+ line-height: 120%;
+ border: 1px solid #ac9;
+ border-left: none;
+ border-right: none;
}
tt {
- background-color: #ecf0f3;
- padding: 0 1px 0 1px;
- font-size: 0.95em;
+ background-color: #ecf0f3;
+ padding: 0 1px 0 1px;
+ font-size: 0.95em;
}
div.mainbody {
- background-color: #ffffff;
- color: #000000;
- padding: 0 20px 30px 20px;
- background-image: url(grad1.jpg);
- background-repeat: repeat-x;
+ background-color: #ffffff;
+ color: #000000;
+ padding: 0 20px 30px 20px;
+ background-image: url(grad1.jpg);
+ background-repeat: repeat-x;
}
div.maintitle {
@@ -224,22 +244,22 @@
color: gray;
}
-ul.mainlinks {
+ul.mainlinks {
margin: 0;
list-style-type: none;
}
-ul.mainlinks li {
+ul.mainlinks li {
display: inline;
}
-ul.mainlinks li a {
+ul.mainlinks li a {
float: left;
padding: 15px;
text-decoration: none;
}
-ul.mainlinks li a span {
+ul.mainlinks li a span {
display: block;
text-align: center;
}
@@ -262,12 +282,14 @@
text-align: center;
}
+/*
.clearall {
float: right;
clear: left;
width: 40%;
border: 4px solid red !important;
}
+*/
.creatorandusers {
margin: 40px auto 0;
@@ -295,8 +317,17 @@
.sectionlogos a {
padding: 10px;
- }
+}
+div.documentwrapper {
+ background-image: url(img/blueprint.jpg) !important;
+}
+
+div#searchbox .searchtip {
+ background-color: #272D7B; /* blueprint blue */
+ padding: 4px 4px 4px 4px;
+}
+
/* AVAILABLE-COLORS
* The set of colors understood by docutils.
*/
Added: buildout-website/trunk/source/_static/hammer-B.ico
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/source/_static/hammer-B.ico
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: buildout-website/trunk/source/_static/hammer-foot.ico
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/source/_static/hammer-foot.ico
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: buildout-website/trunk/source/_static/pencil-cross-hammer.ico
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/source/_static/pencil-cross-hammer.ico
___________________________________________________________________
Added: svn:mime-type
+ application/octet-stream
Added: buildout-website/trunk/source/buildout_theme/static/blueprint.jpg
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/source/buildout_theme/static/blueprint.jpg
___________________________________________________________________
Added: svn:mime-type
+ image/jpeg
Added: buildout-website/trunk/source/buildout_theme/static/buildout-logo.png
===================================================================
(Binary files differ)
Property changes on: buildout-website/trunk/source/buildout_theme/static/buildout-logo.png
___________________________________________________________________
Added: svn:mime-type
+ image/png
Added: buildout-website/trunk/source/buildout_theme/static/buildout.css_t
===================================================================
--- buildout-website/trunk/source/buildout_theme/static/buildout.css_t (rev 0)
+++ buildout-website/trunk/source/buildout_theme/static/buildout.css_t 2009-04-01 22:51:46 UTC (rev 98780)
@@ -0,0 +1,404 @@
+/**
+ * Sphinx stylesheet -- buildout theme
+ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ */
+
+ at import url("basic.css");
+
+/* -- page layout ----------------------------------------------------------- */
+
+body {
+ font-family: {{ theme_bodyfont }};
+ font-size: 100%;
+ background-color: {{ theme_footerbgcolor }};
+ color: #000;
+ margin: 0;
+ padding: 0;
+}
+
+div.document {
+ background-color: {{ theme_sidebarbgcolor }};
+}
+
+div.body {
+ background-color: {{ theme_bgcolor }};
+ color: {{ theme_textcolor }};
+ padding: 0 20px 30px 20px;
+}
+
+{%- if theme_rightsidebar|tobool %}
+div.bodywrapper {
+ margin: 0 230px 0 0;
+}
+{%- endif %}
+
+div.footer {
+ color: {{ theme_footertextcolor }};
+ width: 100%;
+ padding: 9px 0 9px 0;
+ text-align: center;
+ font-size: 75%;
+}
+
+div.footer a {
+ color: {{ theme_footertextcolor }};
+ text-decoration: underline;
+}
+
+div.related { /* horizontal bar across the top */
+ background-color: {{ theme_relbarbgcolor }};
+ line-height: 30px;
+ color: {{ theme_relbartextcolor }};
+}
+
+div.related a {
+ color: {{ theme_relbarlinkcolor }};
+}
+
+div.sphinxsidebar {
+ {%- if theme_stickysidebar|tobool %}
+ top: 30px;
+ margin: 0;
+ position: fixed;
+ overflow: auto;
+ height: 100%;
+ {%- endif %}
+ {%- if theme_rightsidebar|tobool %}
+ float: right;
+ {%- if theme_stickysidebar|tobool %}
+ right: 0;
+ {%- endif %}
+ {%- endif %}
+}
+
+{%- if theme_stickysidebar|tobool %}
+/* this is nice, but it it leads to hidden headings when jumping
+ to an anchor */
+/*
+div.related {
+ position: fixed;
+}
+
+div.documentwrapper {
+ margin-top: 30px;
+}
+*/
+{%- endif %}
+
+div.sphinxsidebar h3 {
+ font-family: {{ theme_headfont }};
+ color: {{ theme_sidebartextcolor }};
+ font-size: 1.2em;
+ font-weight: normal;
+ margin: 0;
+ padding: 4px 4px 4px 4px;
+
+ background-color: #272D7B; /* blueprint blue */
+ -moz-border-radius: 5px;
+ -webkit-border-radius: 5px;
+ border: 2px solid #878DDB;
+}
+
+div.sphinxsidebar h3 a {
+ color: {{ theme_sidebartextcolor }};
+}
+
+div.sphinxsidebar h4 {
+ font-family: {{ theme_headfont }};
+ color: {{ theme_sidebartextcolor }};
+ font-size: 1.3em;
+ font-weight: normal;
+ margin: 5px 0 0 0;
+ padding: 4px 4px 4px 4px;
+
+ background-color: #272D7B; /* blueprint blue */
+ -moz-border-radius: 5px;
+ -webkit-border-radius: 5px;
+ border: 2px solid #878DDB;
+}
+
+div.sphinxsidebar p {
+ color: {{ theme_sidebartextcolor }};
+}
+
+div.sphinxsidebar p.topless {
+ margin: 5px 10px 10px 10px;
+}
+
+div.sphinxsidebar ul {
+ margin: 10px;
+ padding: 0;
+ color: {{ theme_sidebartextcolor }};
+}
+
+div.sphinxsidebar a {
+ color: {{ theme_sidebarlinkcolor }};
+
+ background-color: #272D7B; /* blueprint blue */
+ padding: 4px 4px 4px 4px;
+ font-size: 1.2em;
+ font-weight: bold;
+}
+
+div.sphinxsidebar a:hover {
+ color: white;
+ text-decoration: none;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid {{ theme_sidebarlinkcolor }};
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+/* -- body styles ----------------------------------------------------------- */
+
+a {
+ color: {{ theme_linkcolor }};
+ text-decoration: none;
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+div.body p, div.body dd, div.body li {
+ text-align: justify;
+ line-height: 130%;
+}
+
+div.body h1,
+div.body h2,
+div.body h3,
+div.body h4,
+div.body h5,
+div.body h6 {
+ font-family: {{ theme_headfont }};
+ background-color: {{ theme_headbgcolor }};
+ font-weight: normal;
+ color: {{ theme_headtextcolor }};
+ border-bottom: 1px solid #ccc;
+ margin: 20px -20px 10px -20px;
+ padding: 3px 0 3px 10px;
+}
+
+div.body h1 { margin-top: 0; font-size: 200%; }
+div.body h2 { font-size: 160%; }
+div.body h3 { font-size: 140%; }
+div.body h4 { font-size: 120%; }
+div.body h5 { font-size: 110%; }
+div.body h6 { font-size: 100%; }
+
+a.headerlink {
+ color: {{ theme_headlinkcolor }};
+ font-size: 0.8em;
+ padding: 0 4px 0 4px;
+ text-decoration: none;
+}
+
+a.headerlink:hover {
+ background-color: {{ theme_headlinkcolor }};
+ color: white;
+}
+
+div.body p, div.body dd, div.body li {
+ text-align: justify;
+ line-height: 130%;
+}
+
+div.admonition p.admonition-title + p {
+ display: inline;
+}
+
+div.note {
+ background-color: #eee;
+ border: 1px solid #ccc;
+}
+
+div.seealso {
+ background-color: #ffc;
+ border: 1px solid #ff6;
+}
+
+div.topic {
+ background-color: #eee;
+}
+
+div.warning {
+ background-color: #ffe4e4;
+ border: 1px solid #f66;
+}
+
+p.admonition-title {
+ display: inline;
+}
+
+p.admonition-title:after {
+ content: ":";
+}
+
+pre {
+ padding: 5px;
+ background-color: {{ theme_codebgcolor }};
+ color: {{ theme_codetextcolor }};
+ line-height: 120%;
+ border: 1px solid #ac9;
+ border-left: none;
+ border-right: none;
+}
+
+tt {
+ background-color: #ecf0f3;
+ padding: 0 1px 0 1px;
+ font-size: 0.95em;
+}
+
+
+/* ADDITION: A set of colors that can be used within text roles, such as:
+ * :red:`this is red`
+ */
+
+.maroon { color: maroon; }
+.red { color: red; }
+.magenta { color: magenta; }
+.fuchsia { color: fuchsia; }
+.pink { color: #FAA; }
+.orange { color: orange; }
+.yellow { color: yellow; }
+.lime { color: lime; }
+.green { color: green; }
+.olive { color: olive; }
+.teal { color: teal; }
+.cyan { color: cyan; }
+.aqua { color: aqua; }
+.blue { color: blue; }
+.navy { color: navy; }
+.purple { color: purple; }
+.black { color: black; }
+.gray { color: gray; }
+.silver { color: silver; }
+.white { color: white; }
+
+div#searchbox .searchtip { /* helpful tip below searchbox in left column */
+ background-color: #272D7B; /* blueprint blue */
+ padding: 4px 4px 4px 4px;
+}
+
+div.documentwrapper { /* apply a wallpaper to the frame around the content */
+ background-image: url(blueprint.jpg);
+}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+div.mainbody {
+ background-color: #ffffff;
+ color: #000000;
+ padding: 0 20px 30px 20px;
+ background-image: url(grad1.jpg);
+ background-repeat: repeat-x;
+}
+
+div.maintitle {
+ padding-top: 15px;
+ font-size: 29px;
+ text-align: center;
+ font-weight: bold;
+}
+
+div.maindescription {
+ font-size: 19px;
+ font-weight: bold;
+}
+
+div.maindescription p {
+ text-align: center;
+ color: gray;
+}
+
+ul.mainlinks {
+ margin: 0;
+ list-style-type: none;
+}
+
+ul.mainlinks li {
+ display: inline;
+}
+
+ul.mainlinks li a {
+ float: left;
+ padding: 15px;
+ text-decoration: none;
+}
+
+ul.mainlinks li a span {
+ display: block;
+ text-align: center;
+}
+
+ul.mainlinks li a span.linktitle {
+ font-size: 22px;
+ font-weight: bold;
+ padding-bottom: 15px;
+}
+
+ul.mainlinks li a span.linkdesc {
+ font-size: 10px;
+ display: block;
+ padding-top: 10px;
+}
+
+div.testimonials {
+ margin: 0 auto;
+ width: 690px;
+ text-align: center;
+}
+
+/*
+.clearall {
+ float: right;
+ clear: left;
+ width: 40%;
+ border: 4px solid red !important;
+}
+*/
+
+.creatorandusers {
+ margin: 40px auto 0;
+ width: 710px;
+}
+
+.sectiontitle {
+ float: left;
+ text-align: right;
+ width: 200px;
+ font-size: 24px;
+}
+
+.sectioncontent {
+ float: right;
+ width: 460px;
+ font-size: 18px;
+ line-height: 140%;
+}
+
+.sectionlogos {
+ margin: 10px auto 0;
+ width: 410px;
+}
+
+.sectionlogos a {
+ padding: 10px;
+}
+
Added: buildout-website/trunk/source/buildout_theme/theme.conf
===================================================================
--- buildout-website/trunk/source/buildout_theme/theme.conf (rev 0)
+++ buildout-website/trunk/source/buildout_theme/theme.conf 2009-04-01 22:51:46 UTC (rev 98780)
@@ -0,0 +1,28 @@
+[theme]
+inherit = basic
+stylesheet = buildout.css
+pygments_style = sphinx
+
+[options]
+rightsidebar = false
+stickysidebar = false
+
+footerbgcolor = #11303d
+footertextcolor = #ffffff
+sidebarbgcolor = #1c4e63
+sidebartextcolor = #ffffff
+sidebarlinkcolor = #b8ebfc
+relbarbgcolor = #272D7B
+relbartextcolor = #ffffff
+relbarlinkcolor = #ffffff
+bgcolor = #ffffff
+textcolor = #000000
+headbgcolor = #f2f2f2
+headtextcolor = #20435c
+headlinkcolor = #c60f0f
+linkcolor = #355f7c
+codebgcolor = #eeffcc
+codetextcolor = #333333
+
+bodyfont = sans-serif
+headfont = 'Trebuchet MS', sans-serif
Modified: buildout-website/trunk/source/conf.py
===================================================================
--- buildout-website/trunk/source/conf.py 2009-04-01 22:47:29 UTC (rev 98779)
+++ buildout-website/trunk/source/conf.py 2009-04-01 22:51:46 UTC (rev 98780)
@@ -73,10 +73,13 @@
#JEFF html_translator_class = 'embeddedvideo.MyHTMLTranslator'
+html_theme = 'buildout_theme'
+html_theme_path = ['.']
+
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
-html_style = 'default.css'
+# html_style = 'default.css'
# 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,
@@ -91,28 +94,36 @@
# typographically correct entities.
#html_use_smartypants = True
-# Content template for the index page.
-#html_index = ''
-
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
html_additional_pages = {
- 'index': 'index.html' # we like a customized frontpage
+ 'index': 'index.html', # we like a customized frontpage
}
# If false, no module index is generated.
-#html_use_modindex = True
+html_use_modindex = False
# If true, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = True
+html_copy_source = True
# Output file base name for HTML help builder.
-htmlhelp_basename = 'Buildoutdoc'
+#htmlhelp_basename = 'Buildoutdoc'
+# Add "permalinks" for each heading and description.
+html_add_permalinks = True
+# An .ico format of file that is 16x16 or 32x32 pixels in size.
+html_favicon = '_static/hammer-foot.ico'
+#html_favicon = '_static/hammer-B.ico'
+#html_favicon = '_static/pencil-cross-hammer.ico'
+
+html_logo = 'buildout_theme/static/buildout-logo.png'
+
+
+
# Options for LaTeX output
# ------------------------
Modified: buildout-website/trunk/source/docs/dirstruct.rst
===================================================================
--- buildout-website/trunk/source/docs/dirstruct.rst 2009-04-01 22:47:29 UTC (rev 98779)
+++ buildout-website/trunk/source/docs/dirstruct.rst 2009-04-01 22:51:46 UTC (rev 98780)
@@ -138,3 +138,4 @@
----
+Hello.
Added: buildout-website/trunk/source/docs/usecase_singlemod.rst
===================================================================
--- buildout-website/trunk/source/docs/usecase_singlemod.rst (rev 0)
+++ buildout-website/trunk/source/docs/usecase_singlemod.rst 2009-04-01 22:51:46 UTC (rev 98780)
@@ -0,0 +1,72 @@
+Use Case - A Single Module
+==========================
+
+This is a simple use of *zc.buildout* to manage a project that is distributed
+as a single module. Here are the commands one might use to obtain a copy of
+the source from the Cheeseshop for examination::
+
+ $ easy_install --editable --build-directory . xanalogica.tumbler
+ $ cd xanalogica.tumbler
+
+If we were going to develop with the project we might instead check out a copy
+from version control::
+
+ $ svn co http://svn.taupro.com/xanalogica.tumbler/trunk/ xanalogica.tumbler
+
+After obtaining a copy in either manner, the following commands would
+bootstrap the buildout environment and build it up-to-date, satisfying any
+additional dependencies given in the module's :file:`setup.py`.
+
+::
+
+ $ python bootstrap.py
+ $ bin/buildout
+
+.. sidebar:: Single-Module buildout.cfg
+
+ .. parsed-literal::
+
+ [buildout]
+ develop = .
+ parts =
+ xprompt
+ test
+
+ [xprompt]
+ recipe = zc.recipe.egg:scripts
+ eggs = xanalogica.tumbler
+ interpreter = xprompt
+
+ [test]
+ recipe = zc.recipe.testrunner
+ eggs = xanalogica.tumbler
+
+Examining the buildout specification, we see that it consists of two parts,
+one named "test" and one named "xprompt". The list of parts, in the order
+they are built, is given in the "parts = " line. The "[buildout]" section is
+the top-most section and the only one that is required. Entries that control
+the global operation of *zc.buildout* go here.
+
+Every part uses a recipe to oversee its installation/uninstallation and the
+name of a part is arbitrary. In some cases a recipe will create files using
+or prefixed with the part name. All other "name = value" lines underneath a
+part section are simple arguments that are passed to the recipe at build time.
+
+For the "xprompt" part, we simply specify that it requires a single egg, named
+"xanalogica.tumbler". We also say using the "interpreter =" line that we want
+a Python interpreter named "xprompt" that maps only that egg onto *sys.path*.
+In this manner we can exercise the logic of the egg interactively.
+
+For the "test" part, the xanalogica.tumbler egg has provided unit tests and we
+want access to a script that will invoke them. The "zc.recipe.testrunner"
+recipe provides this and generates such a script under the bin/ directory
+named after the name or in the case "test". To run the unit tests::
+
+ $ bin/test
+
+Both parts reference the xanalogica.tumbler egg and ordinarily *zc.buildout*
+would fetch an egg from the Cheeseshop by that name. However, the "develop ="
+line tells *zc.buildout* to add the egg defined by the :file:`setup.py` in the
+current directory to the list of candidates. Since *zc.buildout* prefers eggs
+under development over finished eggs in the Cheeseshop, this means it will use
+our local module to satisfy the search for "xanalogica.tumbler".
Property changes on: buildout-website/trunk/source/docs/usecase_singlemod.rst
___________________________________________________________________
Added: svn:mime-type
+ text/plain
Added: svn:keywords
+ Author Date Id Revision
Added: svn:eol-style
+ native
Modified: buildout-website/trunk/source/index.rst
===================================================================
--- buildout-website/trunk/source/index.rst 2009-04-01 22:47:29 UTC (rev 98779)
+++ buildout-website/trunk/source/index.rst 2009-04-01 22:51:46 UTC (rev 98780)
@@ -7,7 +7,7 @@
quotes
install
docs/dirstruct
- docs/usecase1_singlemod
+ docs/usecase_singlemod
docs/usecase2_wrapmods
docs/usecase3_wrapckout
docs/index
More information about the Checkins
mailing list