Rewrite a decent portion of the rst bits. Also provide some

documentation.
This commit is contained in:
Dave Snider 2013-11-04 22:44:33 -08:00
parent d287776604
commit ed73ac347a
5 changed files with 110 additions and 5562 deletions

View File

@ -221,8 +221,27 @@ footer
color: $gray-light
p
margin-bottom: $base-line-height / 2
.rst-footer-buttons
+clearfix
#search-results
.search li
margin-bottom: $base-line-height
border-bottom: solid 1px $table_border_color
padding-bottom: $base-line-height
.search li:first-child
border-top: solid 1px $table_border_color
padding-top: $base-line-height
.search li a
font-size: 120%
margin-bottom: $base-line-height / 2
display: inline-block
.context
color: $text-medium
font-size: 90%
+media($tablet)
.wy-body-for-nav
background: $section-background-color

View File

@ -1,10 +1,36 @@
// -------------------------------------------------------------------------------------------------------------------
// CONTRIBUTORS, PLEASE READ THIS!
// -------------------------------------------------------------------------------------------------------------------
// Couple things...
// 1. Lots of this @extends from wyrm_core/_type.sass (http://www.github.com/snide/wyrm/.
// * Try not to replace any @extends code. It's pretty generic stuff meant to work together.
// * That said, know that I'm very unlikely to accept PRs from wyrm just to change style here.
// 2. I plan to remove the !importants in here. Part of it is due to lazyness, part to sphinx's fondness for nesting.
// 3. Try to use variables from wyrm_core/wy_variables.sass. Notable are...
// * $base-line-height // All margins, padding and line-height should use this in .25 increments.
// * $text-color, $text-light, #text-dark...etc
// * $base-font-family, $custom-font-family, $code-font-family
// 4. If you have changes for mobile/tablet, put them at the bottom of the sass file.
// --------------------------------------------------------------------------------------------------------------------
.rst-content
// sometimes people provide sizing in their rst, while will break the responsive layout
// Sphinx by default applies HxW style attributes to images. This fixes that oversite.
img
max-width: 100%
height: auto !important
// Usually it's a good idea to give images some space.
.section > img
margin-bottom: $base-line-height
// For the most part, its safe to assume that sphinx wants you to use a blockquote as an indent. It gets
// used in many different ways, so don't assume you can apply some fancy style, just leave it be.
blockquote
margin-left: $base-line-height
line-height: $base-line-height
margin-bottom: $base-line-height
// These are the various note pullouts that sphinx applies
.note, .attention, .caution, .danger, .error, .hint, .important, .tip, .warning
@extend .wy-alert
p.last, p.first
@ -27,6 +53,8 @@
@extend .wy-plain-list-disc
.section ol, ol.simple, ol.arabic
@extend .wy-plain-list-decimal
// Generics handling of headings and toc stuff.
.topic-title
font-weight: bold
margin-bottom: $base-line-height / 2
@ -38,6 +66,8 @@
.align-left
float: left
margin: 0px $base-line-height $base-line-height 0px
// This is the #href that shows up on hover. Sphinx's is terrible so I hack it away.
h1, h2, h3, h4, h5, h6, dl dt
.headerlink
display: none
@ -52,6 +82,7 @@
&:hover .headerlink
display: inline-block
// Sidebar content. You'll see at the bottom of this file I change it in mobile.
.sidebar
float: right
width: 40%
@ -60,6 +91,7 @@
padding: $base-line-height
background: $table-stripe-color
border: solid 1px $table-border-color
// Sidebar content is usually less relevant, so adjust the margins and sizes.
p, ul, dl
font-size: 90%
.last
@ -74,12 +106,13 @@
margin-bottom: $base-line-height
font-size: 100%
table.docutils
@extend .wy-table
@extend .wy-table-bordered-all
&:not(.field-list)
@extend .wy-table-striped
// These are the little citation links [1] that show up within paragraphs.
.footnote-reference, .citation-reference
vertical-align: super
font-size: 90%
// Tables! Sphinx LOVES TABLES. Most of wyrm assumes you're only going to use a table as a table
// so I have to write a bunch of unique stuff for Sphinx to style them up differently like it's 2003.
table.docutils.citation, table.docutils.footnote
background: none
border: none
@ -92,11 +125,12 @@
padding-left: 0
padding-right: 0
vertical-align: top
.footnote-reference, .citation-reference
vertical-align: super
font-size: 90%
table.docutils
@extend .wy-table
@extend .wy-table-bordered-all
&:not(.field-list)
@extend .wy-table-striped
// This table is what gets spit out for auto-generated API stuff. I style it smaller bits of padding.
table.docutils.field-list
@extend .wy-table
border: none
@ -108,29 +142,60 @@
.field-body
text-align: left
padding-left: 0
// This is seen in sphinx.ext.autodoc output
// These are the "literals" that get spit out when you mark stuff as ``code`` as your write.
tt
@extend code
color: $black
big, em
font-size: 100% !important
line-height: normal
.xref, a &
font-weight: bold
// This is what Sphinx spits out for it's autodocs. Depending upon what language the person is referencing
// these things usually have a class of "method" or "class" or something similar, but really who knows.
// Sphinx doesn't give me a generic class on these, so unfortunately I have to apply it to the root dl.
// This makes me terribly unhappy and makes this code very nesty. Unfortunately I've seen hand-written docs
// that output similar, but not quite the same nesting so this is really the best we can do.
dl
// This would be the equivilant of a .. class::
dt
display: inline-block
margin: $base-line-height / 4 0
font-size: 90%
line-height: normal
background: $gray-lighter
color: $gray-dark
border: none
border-left: solid 3px $gray-light
background: lighten($blue, 50%)
color: $blue
border-top: solid 3px lighten($blue, 20%)
padding: $base-line-height / 4
&:before
color: lighten($blue, 20%)
.headerlink
color: $text-color
font-size: 100% !important
dt:first-child
margin-top: 0
// And this would be the .. method::
dl dt
margin-bottom: $base-line-height / 4
border: none
border-left: solid 3px hsl(0,0%,80%)
background: hsl(0,0%,94%)
color: $text-medium
.headerlink
color: $text-color
font-size: 100% !important
// This is the description for the class/method.
dd
margin-left: $base-line-height
tt // for sphinx.ext.autodoc generated content
// Most of the content within these dls are one liners, so I halve the normal margins.
p, table, ul, ol
margin-bottom: $base-line-height / 2 !important
dt:first-child
margin-top: 0
// Since dts get the callout style, we treat this less as callouts.
tt
font-weight: bold
&.descname, &.descclassname
background-color: transparent
border: none
@ -139,61 +204,7 @@
&.descname
font-weight: bold
dl dl
dt
display: inline-block
margin-bottom: $base-line-height / 4
font-size: 90%
background: none
border: none
.headerlink
color: $text-color
font-size: 100% !important
// reST for ``inline code`` statements
// This does a few things to make inline code easier to read
// Even though the font size of $code-font-family is same as normal font
// it looks huge compared to it, so lets trial with it @ 90%.
tt
white-space: nowrap
max-width: 100%
background: $white
border: solid 1px $table-border-color
color: $text-color
font-size: 80%
padding: 0 5px
font-family: $code-font-family
overflow-x: auto
big, em
font-size: 100% !important
line-height: normal
.xref, a &
font-weight: bold
blockquote
margin-left: $base-line-height
line-height: $base-line-height
margin-bottom: $base-line-height
#search-results
.search li
margin-bottom: $base-line-height
border-bottom: solid 1px $table_border_color
padding-bottom: $base-line-height
.search li:first-child
border-top: solid 1px $table_border_color
padding-top: $base-line-height
.search li a
font-size: 120%
margin-bottom: $base-line-height / 2
display: inline-block
.context
color: $text-medium
font-size: 90%
// Mobile specific
+media($mobile)
.rst-content
.sidebar

View File

@ -23,7 +23,7 @@
{% endif %}
{# CSS #}
<link href='http://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700' rel='stylesheet' type='text/css'>
<link href='http://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
{# JS #}
{% if not embedded %}

View File

@ -1,236 +1 @@
/* line 2, /home/tony/workspace/sphinx_rtd_theme/bower_components/neat/app/assets/stylesheets/grid/_grid.scss */
* {
-webkit-box-sizing: border-box;
-moz-box-sizing: border-box;
box-sizing: border-box;
}
/* line 70, /home/tony/workspace/sphinx_rtd_theme/bower_components/wyrm/sass/wyrm_core/_mixin.sass */
.font-smooth, .icon:before {
-webkit-font-smoothing: antialiased;
}
/* line 124, /home/tony/workspace/sphinx_rtd_theme/bower_components/wyrm/sass/wyrm_core/_mixin.sass */
.clearfix {
*zoom: 1;
}
/* line 117, /home/tony/workspace/sphinx_rtd_theme/bower_components/wyrm/sass/wyrm_core/_mixin.sass */
.clearfix:before, .clearfix:after {
display: table;
content: "";
}
/* line 121, /home/tony/workspace/sphinx_rtd_theme/bower_components/wyrm/sass/wyrm_core/_mixin.sass */
.clearfix:after {
clear: both;
}
@font-face {
font-family: fontawesome-webfont;
font-weight: normal;
font-style: normal;
src: url("../font/fontawesome_webfont.eot");
src: url("../font/fontawesome_webfont.eot?#iefix") format("embedded-opentype"), url("../font/fontawesome_webfont.woff") format("woff"), url("../font/fontawesome_webfont.ttf") format("truetype"), url("../font/fontawesome_webfont.svg#fontawesome-webfont") format("svg");
}
/* line 5, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge_fa.sass */
.icon:before {
display: inline-block;
font-family: fontawesome-webfont;
font-style: normal;
font-weight: normal;
line-height: 1;
text-decoration: inherit;
}
/* line 14, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge_fa.sass */
a .icon {
display: inline-block;
text-decoration: inherit;
}
/* line 20, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge_fa.sass */
li .icon {
display: inline-block;
}
/* line 22, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge_fa.sass */
li .icon-large:before,
li .icon-large:before {
/* 1.5 increased font size for icon-large * 1.25 width */
width: 1.875em;
}
/* line 27, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge_fa.sass */
ul.icons {
list-style-type: none;
margin-left: 2em;
text-indent: -0.8em;
}
/* line 32, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge_fa.sass */
ul.icons li .icon {
width: 0.8em;
}
/* line 34, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge_fa.sass */
ul.icons li .icon-large:before,
ul.icons li .icon-large:before {
/* 1.5 increased font size for icon-large * 1.25 width */
vertical-align: baseline;
}
/* line 40, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge_fa.sass */
.icon-book:before {
content: "\f02d";
}
/* line 43, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge_fa.sass */
.icon-caret-down:before {
content: "\f0d7";
}
/* line 46, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge_fa.sass */
.icon-caret-up:before {
content: "\f0d8";
}
/* line 49, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge_fa.sass */
.icon-caret-left:before {
content: "\f0d9";
}
/* line 52, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge_fa.sass */
.icon-caret-right:before {
content: "\f0da";
}
/* line 1, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions {
position: fixed;
bottom: 0;
left: 0;
width: 300px;
color: #fcfcfc;
background: #1f1d1d;
border-top: solid 10px #343131;
font-family: "Lato", "proxima-nova", "Helvetica Neue", Arial, sans-serif;
z-index: 400;
}
/* line 11, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions a {
color: #2980b9;
text-decoration: none;
}
/* line 14, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions .rst-badge-small {
display: none;
}
/* line 16, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions .rst-current-version {
padding: 12px;
background-color: #272525;
display: block;
text-align: right;
font-size: 90%;
cursor: pointer;
color: #27ae60;
*zoom: 1;
}
/* line 117, /home/tony/workspace/sphinx_rtd_theme/bower_components/wyrm/sass/wyrm_core/_mixin.sass */
.rst-versions .rst-current-version:before, .rst-versions .rst-current-version:after {
display: table;
content: "";
}
/* line 121, /home/tony/workspace/sphinx_rtd_theme/bower_components/wyrm/sass/wyrm_core/_mixin.sass */
.rst-versions .rst-current-version:after {
clear: both;
}
/* line 25, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions .rst-current-version .icon {
color: #fcfcfc;
}
/* line 27, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions .rst-current-version .icon-book {
float: left;
}
/* line 29, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions .rst-current-version.rst-out-of-date {
background-color: #e74c3c;
color: white;
}
/* line 32, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions.shift-up .rst-other-versions {
display: block;
}
/* line 34, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions .rst-other-versions {
font-size: 90%;
padding: 12px;
color: gray;
display: none;
}
/* line 39, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions .rst-other-versions hr {
display: block;
height: 1px;
border: 0;
margin: 20px 0;
padding: 0;
border-top: solid 1px #413d3d;
}
/* line 46, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions .rst-other-versions dd {
display: inline-block;
margin: 0;
}
/* line 49, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions .rst-other-versions dd a {
display: inline-block;
padding: 6px;
color: #fcfcfc;
}
/* line 53, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions.rst-badge {
width: auto;
bottom: 20px;
right: 20px;
left: auto;
border: none;
max-width: 300px;
}
/* line 60, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions.rst-badge .icon-book {
float: none;
}
/* line 62, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions.rst-badge.shift-up .rst-current-version {
text-align: right;
}
/* line 64, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions.rst-badge.shift-up .rst-current-version .icon-book {
float: left;
}
/* line 66, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions.rst-badge .rst-current-version {
width: auto;
height: 30px;
line-height: 30px;
padding: 0 6px;
display: block;
text-align: center;
}
@media screen and (max-width: 768px) {
/* line 75, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions {
width: 85%;
display: none;
}
/* line 78, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
.rst-versions.shift {
display: block;
}
/* line 80, /home/tony/workspace/sphinx_rtd_theme/sass/_theme_badge.sass */
img {
width: 100%;
height: auto;
}
}
*{-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}.font-smooth,.icon:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:before,.clearfix:after{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:fontawesome-webfont;font-weight:normal;font-style:normal;src:url("../font/fontawesome_webfont.eot");src:url("../font/fontawesome_webfont.eot?#iefix") format("embedded-opentype"),url("../font/fontawesome_webfont.woff") format("woff"),url("../font/fontawesome_webfont.ttf") format("truetype"),url("../font/fontawesome_webfont.svg#fontawesome-webfont") format("svg")}.icon:before{display:inline-block;font-family:fontawesome-webfont;font-style:normal;font-weight:normal;line-height:1;text-decoration:inherit}a .icon{display:inline-block;text-decoration:inherit}li .icon{display:inline-block}li .icon-large:before,li .icon-large:before{width:1.875em}ul.icons{list-style-type:none;margin-left:2em;text-indent:-0.8em}ul.icons li .icon{width:0.8em}ul.icons li .icon-large:before,ul.icons li .icon-large:before{vertical-align:baseline}.icon-book:before{content:"\f02d"}.icon-caret-down:before{content:"\f0d7"}.icon-caret-up:before{content:"\f0d8"}.icon-caret-left:before{content:"\f0d9"}.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;border-top:solid 10px #343131;font-family:"Lato","proxima-nova","Helvetica Neue",Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60;*zoom:1}.rst-versions .rst-current-version:before,.rst-versions .rst-current-version:after{display:table;content:""}.rst-versions .rst-current-version:after{clear:both}.rst-versions .rst-current-version .icon{color:#fcfcfc}.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:gray;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:solid 1px #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px}.rst-versions.rst-badge .icon-book{float:none}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge .rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width: 768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}img{width:100%;height:auto}}

File diff suppressed because one or more lines are too long