wagtail/docs
Tim Heap ddebafa119 Remove libsass dependency, precompile CSS for distribution
Depending on libsass for all Wagtail installations was causing issues
with various operating systems, dramatically increasing installation
times, and preventing front end development adopting modern practices.

libsass has been removed as a dependency. Sass files are compiled before
release as a dependency of the `sdist` setup command. Sass compilation
is done through `gulp`. People wishing to hack on the frontend assets
should now install wagtail locally, install the node dependencies, and
run `gulp`:

    $ pip install -e path/to/wagtail
    $ cd path/to/wagtail
    $ npm install
    $ npm start

All the templates and JS files have been updated to reference the new
compiled CSS files instead of the Sass files.

Precompiled CSS for jquery-ui and similar have been moved out of the
`scss/` directory to the `css/` directory.
2015-05-01 08:53:04 +10:00
..
_static Screenshots in 0.7 release notes 2014-10-08 16:42:54 +01:00
contrib revert typo fix which wasn't 2015-04-27 14:22:15 +01:00
contributing added JS documentation to the contributing section 2015-04-27 23:05:36 +12:00
editor_manual Started fixing spellings. Added wordlist 2015-04-17 23:05:08 +01:00
getting_started Remove libsass dependency, precompile CSS for distribution 2015-05-01 08:53:04 +10:00
howto Remove libsass dependency, precompile CSS for distribution 2015-05-01 08:53:04 +10:00
images Removed patterns() from docs 2015-04-10 16:57:05 +01:00
pages remove note that was meaningful when the rich text tag library was called rich_text, but isn't any more 2015-04-27 15:23:47 +01:00
reference Spelling corrections 2015-04-19 10:53:34 +01:00
releases Finalise 0.8.7 in documentation 2015-04-29 14:08:32 +01:00
search Started fixing spellings. Added wordlist 2015-04-17 23:05:08 +01:00
Makefile Added spellcheker 2015-04-17 22:49:16 +01:00
README.md auto doc builder notes 2014-03-11 17:39:13 +00:00
autobuild.sh Roadmap update and auto doc builder 2014-03-11 17:39:13 +00:00
conf.py Update docs copyright year 2015-04-25 13:01:58 -05:00
form_builder.rst Started fixing spellings. Added wordlist 2015-04-17 23:05:08 +01:00
index.rst created contrib section in docs, made amends to css styleguide 2015-04-18 08:34:54 +12:00
requirements.txt Update django-taggit in docs 2015-03-27 15:15:57 +00:00
snippets.rst Started fixing spellings. Added wordlist 2015-04-17 23:05:08 +01:00
spelling_wordlist.txt Spelling corrections 2015-04-19 10:53:34 +01:00
support.rst Include Twitter account in support contacts. 2014-02-18 23:03:42 +00:00

README.md

Wagtail docs

These are Sphinx docs, automatically built at http://docs.wagtail.io when the master branch is committed to Github. To build them locally, install Sphinx and the RTD theme:

pip install Sphinx
pip install sphinx-rtd-theme

Then make html from this directory, and open _build/html/index.html in your browser.

We've provided a watchdog script (based on @jacobian's snippet) to auto-build your local docs when you save them. Install watchdog:

pip install watchdog

Then run ./autobuild.sh before you start editing.

The online editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.