From cac4b4e6e9a2fa47ddb6f073d23efc14380ef0cb Mon Sep 17 00:00:00 2001 From: Dave Snider Date: Tue, 5 Nov 2013 11:43:17 -0800 Subject: [PATCH] comments --- README.rst | 4 ++-- sass/_theme_variables.sass | 4 ++++ sass/theme.sass | 4 ++-- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index aece97c0..2a3e8b4a 100644 --- a/README.rst +++ b/README.rst @@ -72,8 +72,8 @@ Contributing or modifying the theme The sphinx_rtd_theme is primarily a sass_ project that requires a few other sass libraries. I'm using bower_ to manage these dependencies and compass_ to build the css. The good news is I have a very nice set of grunt_ operations that will not only load these dependecies, but watch -for changes, rebuild the sphinx demo docs and build a distributable version of the theme in the ``dist`` -directory. The bad news is this means you'll need to set up your environment similar to that +for changes, rebuild the sphinx demo docs and build a distributable version of the theme. +The bad news is this means you'll need to set up your environment similar to that of a front-end developer (vs. that of a python developer). That means installing node and ruby. Set up your environment diff --git a/sass/_theme_variables.sass b/sass/_theme_variables.sass index d0fc20ee..074199e9 100644 --- a/sass/_theme_variables.sass +++ b/sass/_theme_variables.sass @@ -1,3 +1,7 @@ +// In here are varibles used for sphinx_rtd_theme, they either add to or overwrite the default ones +// that are set in wyrm_core/wy_variables.sass. You'll find wyrm in bower_components if you're looking +// for a reference. + $font-awesome-dir: "../font/" $static-img: "../img/" $mathjax-color: $text-color diff --git a/sass/theme.sass b/sass/theme.sass index d356b11f..cdff2718 100644 --- a/sass/theme.sass +++ b/sass/theme.sass @@ -9,7 +9,7 @@ // Variable defaults set by Wyrm @import wyrm_core/wy_variables -// Variable overrides that change coloring and fonts for your theme. +// Variable overrides that change coloring and fonts for this theme. @import theme_variables // bourbon.io framework @@ -44,7 +44,7 @@ @import wyrm_addons/pygments/pygments @import wyrm_addons/pygments/pygments_light -// Theme specific styles +// Theme specific styles. These are likely the files you want to edit. @import theme_breadcrumbs @import theme_layout @import theme_badge