0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
Lovelyfin00 b336536015 User - Reimplement Gravatar switching without JS
- Resolves #9972
- Avoids inline script for a solution that can be CSS/HTML only
- Use translatable alt text for when the default avatar is selected
- Relates to #1288 & #5247 (CSP compliance)
2023-02-07 21:18:31 +10:00
..
_static Update documentation screenshots for v4.2 (#10028) 2023-02-06 10:59:54 +00:00
_templates use search input type for documentation search 2022-09-23 06:53:34 +10:00
advanced_topics Accessibility checker documentation (#10029) 2023-02-06 12:38:18 +00:00
contributing Fix: Path to test argument in tox command 2023-02-05 16:24:10 +10:00
editor_manual Move editor guide content to its own website 2022-10-28 10:16:32 +01:00
extending Documentation - fix up ModelAdmin items 2023-02-06 10:26:46 +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 Documentation - fix up ModelAdmin items 2023-02-06 10:26:46 +00:00
releases User - Reimplement Gravatar switching without JS 2023-02-07 21:18:31 +10:00
topics Update guide.wagtail.org links to use most up-to-date URL and page name, with "latest" redirect 2023-02-03 11:13:15 +00: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 Fix broken "make livehtml" command 2021-02-04 11:55:02 -08:00
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.