0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 01:22:07 +01:00
wagtail/docs
Storm B. Heg fef8c4ac3c Ensure StreamField panels validation errors are visible (#10673)
...by rendering panels as expanded, regardless of the collapse
setting specified by the Wagtail implementor.

Fixes #8990 partially.
2023-07-18 12:43:17 +01:00
..
_static Update styles for block picker in dark mode (#10644) 2023-07-14 14:42:12 +01:00
_templates
advanced_topics Update docs to cover Elasticsearch 8 support 2023-07-17 16:18:37 +01:00
contributing Update docs to cover Elasticsearch 8 support 2023-07-17 16:18:37 +01:00
editor_manual
extending Implement new Draftail customisation APIs 2023-07-06 13:14:54 +10:00
getting_started Clean whitespace formatting in docs 2023-07-17 22:24:54 +10:00
public Move security.txt to wagtail.org (#9751) 2023-04-21 18:01:09 +01:00
reference Deprecate wagtail.contrib.modeladmin 2023-07-18 12:33:42 +01:00
releases Ensure StreamField panels validation errors are visible (#10673) 2023-07-18 12:43:17 +01:00
topics Add docs and tests for snippets inspect view 2023-07-17 17:19:11 +01:00
autobuild.sh
conf.py Run pyupgrade with --py38-plus 2023-07-14 13:06:41 +01:00
favicon.ico
index.rst Move snippets.md docs to its own directory 2023-05-24 11:06:00 +01:00
logo.png
Makefile
README.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
spelling_wordlist.txt Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00
support.md Resolve multiple typos (spelling and grammar) 2023-05-30 21:07:37 +10:00

Wagtail docs

These are Sphinx docs, automatically built at https://docs.wagtail.org when the main 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 MyST playground at Curvenote or the MyST-Markdown VS Code Extension are helpful tools for working with the MyST syntax.