Historia

Karl Hobley 062d05189b Rename wagtail.wagtailadmin to wagtail.admin Conflicts: docs/advanced_topics/customisation/admin_templates.rst docs/advanced_topics/customisation/page_editing_interface.rst docs/advanced_topics/i18n/duplicate_tree.rst docs/advanced_topics/jinja2.rst docs/advanced_topics/settings.rst docs/getting_started/integrating_into_django.rst docs/getting_started/tutorial.rst docs/reference/hooks.rst docs/reference/pages/panels.rst docs/topics/pages.rst docs/topics/streamfield.rst wagtail/admin/blocks.py wagtail/admin/checks.py wagtail/admin/edit_handlers.py wagtail/admin/forms.py wagtail/admin/rich_text.py wagtail/admin/search.py wagtail/admin/site_summary.py wagtail/admin/templatetags/wagtailadmin_tags.py wagtail/admin/tests/test_admin_search.py wagtail/admin/tests/test_buttons_hooks.py wagtail/admin/tests/test_compare.py wagtail/admin/tests/test_edit_handlers.py wagtail/admin/tests/test_page_chooser.py wagtail/admin/tests/test_pages_views.py wagtail/admin/tests/test_rich_text.py wagtail/admin/tests/test_widgets.py wagtail/admin/tests/tests.py wagtail/admin/urls/__init__.py wagtail/admin/views/account.py wagtail/admin/views/chooser.py wagtail/admin/views/collection_privacy.py wagtail/admin/views/collections.py wagtail/admin/views/home.py wagtail/admin/views/page_privacy.py wagtail/admin/viewsets/model.py wagtail/admin/wagtail_hooks.py wagtail/admin/widgets.py wagtail/contrib/settings/registry.py wagtail/contrib/wagtailsearchpromotions/wagtail_hooks.py wagtail/contrib/wagtailstyleguide/wagtail_hooks.py wagtail/project_template/project_name/settings/base.py wagtail/project_template/project_name/urls.py wagtail/tests/non_root_urls.py wagtail/tests/settings.py wagtail/tests/snippets/models.py wagtail/tests/testapp/models.py wagtail/tests/testapp/wagtail_hooks.py wagtail/tests/urls.py wagtail/wagtaildocs/models.py wagtail/wagtaildocs/views/chooser.py wagtail/wagtaildocs/wagtail_hooks.py wagtail/wagtailembeds/wagtail_hooks.py wagtail/wagtailforms/models.py wagtail/wagtailforms/tests/test_views.py wagtail/wagtailforms/views.py wagtail/wagtailforms/wagtail_hooks.py wagtail/wagtailimages/models.py wagtail/wagtailimages/views/chooser.py wagtail/wagtailimages/wagtail_hooks.py wagtail/wagtailredirects/forms.py wagtail/wagtailredirects/wagtail_hooks.py wagtail/wagtailsites/forms.py wagtail/wagtailsites/views.py wagtail/wagtailsites/wagtail_hooks.py wagtail/wagtailsnippets/tests.py wagtail/wagtailsnippets/wagtail_hooks.py wagtail/wagtailusers/forms.py wagtail/wagtailusers/views/groups.py wagtail/wagtailusers/wagtail_hooks.py		2017-11-26 22:43:47 +00:00
..
_static/images	Add 'The Zen of Wagtail' document	2017-09-27 12:20:34 +01:00
advanced_topics	Rename wagtail.wagtailadmin to wagtail.admin	2017-11-26 22:43:47 +00:00
contributing	Rename wagtail.wagtailcore to wagtail.core	2017-11-26 22:43:47 +00:00
editor_manual	Update documentation referring to the explorer menu	2017-05-17 13:14:50 +01:00
getting_started	Rename wagtail.wagtailadmin to wagtail.admin	2017-11-26 22:43:47 +00:00
reference	Rename wagtail.wagtailadmin to wagtail.admin	2017-11-26 22:43:47 +00:00
releases	Rename wagtail.wagtailcore to wagtail.core	2017-11-26 22:43:47 +00:00
topics	Rename wagtail.wagtailadmin to wagtail.admin	2017-11-26 22:43:47 +00: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
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
readthedocs.yml	requirements_file not needed, but maybe pip_install is	2017-10-09 18:15:36 +01:00
requirements.txt	readthedocs needs a requirements.txt, apparently	2017-10-09 19:45:07 +01:00
spelling_wordlist.txt	Remove references to Gondor.io in documentation.	2017-01-30 12:36:26 +00:00
support.rst	Mention Slack on support documentation	2017-11-15 21:06:45 +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 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.