summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: f30a377fe089f8ff6c3f19756651c1b9ad7751e9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
.. pyScss documentation master file, created by
   sphinx-quickstart2 on Thu Sep 19 18:03:51 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

pyScss, a Sass compiler for Python
==================================

|build-status| |coverage|

.. |build-status| image:: https://travis-ci.org/Kronuz/pyScss.svg?branch=master
    :target: https://travis-ci.org/Kronuz/pyScss

.. |coverage| image:: https://coveralls.io/repos/Kronuz/pyScss/badge.png
    :target: https://coveralls.io/r/Kronuz/pyScss

pyScss is a Python implementation of `Sass`_, a CSS preprocessing language that
adds variables, expressions, nested rules, mixins, inheritance, and other
features that help ease the maintenance of large stylesheets.

.. _Sass: http://sass-lang.com/

pyScss also includes support for Compass, and has an extension mechanism for
adding your own custom behavior.

pyScss is not yet fully compatible with the canonical Ruby implementation, but
we're getting there and constantly improving.  Please feel free to `file a
GitHub issue`_ for anything pyScss gets wrong.

.. _file a GitHub issue: https://github.com/Kronuz/pyScss/issues

.. image:: http://pledgie.com/campaigns/16513.png?skin_name=chrome
   :alt: Click here to lend your support to pyScss and make a donation at pledgie.com!
   :target: http://pledgie.com/campaigns/16513

.. TODO this first page should have some basic usage; there's currently nothing
   particularly helpful on it.  also installation, deps, etc.

Contents:

.. toctree::
    :maxdepth: 2

    usage
    python-api
    syntax
    back-matter


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`