0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
wagtail/docs
David Burke db54a9f0c4 Update IntegerBlock docs to show correct kwargs (#2930)
It should be max and min value - not length. See [here](07c3ba84fb/wagtail/wagtailcore/blocks/field_block.py (L306)).

So this would work 

`blocks.IntegerBlock(max_value=10, min_value=0)`

but this wouldn't do anything

`blocks.IntegerBlock(max_length=10, min_length=0)`
2016-08-20 02:38:00 +01:00
..
_static/images promote rich text link handling to a major feature 2016-05-19 17:01:17 +01:00
advanced_topics Remove deprecated wagtail.wagtailimages.utils module 2016-08-09 20:11:31 +01:00
contributing Add 'issue tracking' docs (#2794) 2016-07-19 16:17:54 +01:00
editor_manual Correcting typo int The Dashboard doc 2016-02-16 15:51:57 -05:00
getting_started Make /admin a link in the Getting Started tutorial 2016-07-20 09:41:03 +01:00
reference Mark django-medusa as no longer maintained 2016-07-29 15:54:52 +01:00
releases Marks names of default formats for translations 2016-08-18 20:43:17 +01:00
topics Update IntegerBlock docs to show correct kwargs (#2930) 2016-08-20 02:38:00 +01:00
autobuild.sh
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 Added spellcheker 2015-04-17 22:49:16 +01:00
README.md Eliminate reference to requirements-dev.txt 2016-02-05 15:48:01 +00:00
requirements.txt Build documentation with Django 1.8 fixes #1451 2015-06-29 09:11:21 +01:00
spelling_wordlist.txt Spellchecked editing api docs 2015-05-18 10:44:07 +01:00
support.rst

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.