0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
Tom Dyson 4fc528bef4
Remove excited tone (#6769)
Revert @phildexter's test PR, in the interest of maintaining our friendly but serious tone. Sorry Phil!
2021-02-04 15:37:57 +00:00
..
_static Add documentation formatting reference (#6729) 2021-01-29 10:38:47 +00:00
advanced_topics Improve wagtailforms accessibility guidance (#6740) 2021-01-29 19:45:48 +00:00
contributing Quote pip install command in developing docs 2021-02-04 12:36:00 +00:00
editor_manual Removed 'how to' 2021-02-04 14:42:18 +00:00
getting_started Remove excited tone (#6769) 2021-02-04 15:37:57 +00:00
reference add missing : to after_create_page example 2021-01-27 09:21:42 +00:00
releases Release note for #6756 in 2.12.1 2021-02-03 11:00:18 +00:00
topics Release notes for #6718 2021-01-26 10:55:26 +00:00
autobuild.sh
conf.py Configure Sphinx for Markdown support (#6711) 2021-01-26 22:09:52 +00:00
favicon.ico
index.rst Revert "Writing documentation in for modes" 2021-02-04 11:51:36 +00:00
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
robots.txt Reinstate spidering of other documentation versions besides stable 2021-02-02 15:15:43 +00:00
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.