From 87f294fe2ebf18988526cf798441bb5e3bb55eb5 Mon Sep 17 00:00:00 2001 From: mprahl Date: Thu, 26 Oct 2017 23:13:56 -0400 Subject: [PATCH] Add an example in the docs about compiling a directory --- docs/index.rst | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 78600ec6..db9c0b54 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -56,13 +56,38 @@ It's available on PyPI_, so you can install it using :program:`pip`: .. _example: -Example -------- +Examples +-------- + +Compile a String of SASS to CSS +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ >>> import sass >>> sass.compile(string='a { b { color: blue; } }') 'a b {\n color: blue; }\n' +Compile a Directory of SASS Files to CSS +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +>>> import sass +>>> import os +>>> os.mkdir('css') +>>> os.mkdir('sass') +>>> scss = """\ +... $theme_color: #cc0000; +... body { +... background-color: $theme_color; +... } +... """ +>>> with open('sass/example.scss', 'w') as example_scss: +... example_scss.write(scss) +... +>>> sass.compile(dirname=('sass', 'css'), output_style='compressed') +>>> with open('css/example.css') as example_css: +... print(example_css.read()) +... +body{background-color:#c00} + User's Guide ------------