0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
Sandil Ranasinghe 3ed84b36da make streamfield migration names from operations
- `operation_name_fragment` property added to operations
- `migration_name_fragment` property added to MigrateStreamData
- added tests, docs updated
- BaseBlockOperation inherits from `abc.ABC`
2023-01-18 19:29:56 +00:00
..
_static Documentation - Fix missing links / images 2023-01-05 12:08:27 +00:00
_templates use search input type for documentation search 2022-09-23 06:53:34 +10:00
advanced_topics make streamfield migration names from operations 2023-01-18 19:29:56 +00:00
contributing Remove react-axe package usage (#9865) 2023-01-10 11:12:19 +00:00
editor_manual Move editor guide content to its own website 2022-10-28 10:16:32 +01:00
extending Updated documentation for adding reports to cover permission restrictions (#9859) 2023-01-09 14:14:53 +00:00
getting_started Link django docs to stable version 2023-01-11 20:18:04 +10:00
public Add a security.txt file 2022-09-06 08:09:30 +10:00
reference Add reference docs for MultipleChooserPanel 2023-01-18 14:31:08 +00:00
releases Axe accessibility checker integration with floating dialog component (#9899) 2023-01-18 15:59:44 +00:00
topics Link django docs to stable version 2023-01-11 20:18:04 +10:00
autobuild.sh
conf.py Documentation - update package versions 2022-10-17 10:07:44 +01:00
favicon.ico
index.rst Re-add editor guide link (#9539) 2022-10-28 15:42:04 +01:00
logo.png
Makefile
README.md Documentation - update dead/redirected links 2022-10-11 20:44:08 +10:00
requirements.txt Documentation - update package versions 2022-10-17 10:07:44 +01:00
spelling_wordlist.txt
support.md Documentation - clean up small typos and whitespace issues 2022-10-13 22:41:33 +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.