0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
kapito e008838d53 Non-obstructive navbar toggle icon
Changes the design of the navbar toggle slightly so that it no longer obstructs page headers.
Currently: https://cdn.pbrd.co/images/GAruhHC.png, https://cdn.pbrd.co/images/GArxXtn.png
With fix: https://cdn.pbrd.co/images/GArvF7ec.png, https://cdn.pbrd.co/images/GArwp3o.png
2017-08-11 03:41:51 +03:00
..
_static/images Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
advanced_topics Make paragraph elements an always-on plugin rather than configurable with plugins 2017-08-10 14:19:34 +01:00
contributing Pin isort to 4.2.5 - fixes #3623 2017-06-02 12:23:49 +01:00
editor_manual Update documentation referring to the explorer menu 2017-05-17 13:14:50 +01:00
getting_started Fix deprecated import of modelcluster.tags in tutorial 2017-06-19 12:23:30 +01:00
reference Extra documentation / release note re the relationship between draft_title and get_admin_display_title 2017-08-03 12:05:52 +01:00
releases Non-obstructive navbar toggle icon 2017-08-11 03:41:51 +03:00
topics Documentation for rich text features 2017-08-10 14:19:34 +01:00
autobuild.sh [skip ci] added commment about autobuild inside vms (#3379) 2017-02-16 21:29:10 +00:00
conf.py Move version from wagtail.wagtailcore to wagtail 2016-08-18 12:05:33 +01:00
index.rst Moved advanced image topics into advanced topics 2016-01-27 11:27:16 +00:00
logo.png reduced size of logo 2015-07-07 14:41:41 +01:00
Makefile add way of autocompile documentation 2017-02-20 20:24:17 +00:00
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00:00
requirements.txt update modelcluster/taggit in doc dependencies 2017-04-05 22:08:38 +01:00
spelling_wordlist.txt Remove references to Gondor.io in documentation. 2017-01-30 12:36:26 +00:00
support.rst Point people to Stack Overflow for support queries in preference to the Google group (#3255) 2017-01-03 16:02:24 +00:00

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 Wagtail's development requirements (in the root Wagtail directory):

pip install -e .[testing,docs]

To build the documentation for browsing, from this directory run:

make html 

then open _build/html/index.html in a browser.

To rebuild automatically while editing the documentation, from this directory run:

sphinx-autobuild . _build

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