0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
LB Johnston 58377402bf Replace ModelAdmin history header human readable date
- Snippet header with history appears to be unused, updated anyway
- Update ModelAdmin header with history to use the human readable (more accessible) timesince date, which uses Tippy.js
- Relates to #8565
- Builds on #8697 & #8566
2023-07-13 00:43:17 +01:00
..
_static Revamp more of the getting started tutorial 2023-06-30 14:49:15 +01:00
_templates Update Algolia DocSearch integration with new application and correct versioning setup 2023-03-10 15:57:17 +00:00
advanced_topics Release notes for #10612 2023-07-12 16:59:53 +01:00
contributing Convert the CONTRIBUTORS file to Markdown 2023-06-28 20:50:12 +10:00
editor_manual Move editor guide content to its own website 2022-10-28 10:16:32 +01:00
extending Implement new Draftail customisation APIs 2023-07-06 13:14:54 +10:00
getting_started Switch the tutorial snippets example to be more understandable #10609 (#10624) 2023-07-03 16:54:49 +01:00
public Move security.txt to wagtail.org (#9751) 2023-04-21 18:01:09 +01:00
reference Add support for --template argument to wagtail start 2023-07-12 13:18:31 +01:00
releases Replace ModelAdmin history header human readable date 2023-07-13 00:43:17 +01:00
topics Allow customising the spreadsheet file name via SnippetViewSet.export_filename 2023-07-12 09:18:11 +01:00
autobuild.sh
conf.py Documentation - update package versions 2022-10-17 10:07:44 +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.