0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
2020-10-22 19:45:34 +10:00
..
_static Update editor manual images where they show the old edit/workflow admin views before revamp 2020-08-07 17:10:26 +01:00
advanced_topics fix duplicate target name enabling_internationalisation 2020-10-16 14:15:33 +01:00
contributing Lint config fixes (#6473) 2020-10-19 21:33:10 +01:00
editor_manual fix trailing whitespace 2020-10-21 12:12:34 +01:00
getting_started Lint docs with doc8 2020-10-03 14:43:03 +01:00
reference Document ModlelAdmin.prepopulated_fields 2020-10-19 21:36:05 +01:00
releases Replace pushPage/popPage with more flexible gotoPage method 2020-10-22 19:45:34 +10:00
topics form_classname meta in FieldBlock (#6470) 2020-10-20 19:17:54 +01:00
autobuild.sh
conf.py Lint config fixes (#6473) 2020-10-19 21:33:10 +01:00
favicon.ico
index.rst
logo.png
Makefile Add config section for doc8 in setup.cfg and ignore _build dir 2020-10-21 12:39:32 +01:00
README.md
requirements.txt
spelling_wordlist.txt Add more names and jargon to spelling wordlist 2020-10-03 14:43:03 +01:00
support.rst Add documentation for reporting security issues 2020-04-20 11:57:26 +10:00

Wagtail docs

These are Sphinx docs, automatically built at https://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.