0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
Vu Pham 68287e97e1 Add base_url_path functionality to ModelAdmin
- Co-Authored-By: Khanh Hoang <39248704+thoang43@users.noreply.github.com>
- adds ability to set `base_url_path` on ModelAdmin to override the `app_name`/`model` URL building behaviour
- fixes #8038
2022-04-18 14:32:18 +10:00
..
_static Pin sphinx-wagtail-theme==5.1.0 2022-04-07 18:53:52 +01:00
_templates Indent templates with djhtml 2022-02-12 01:15:51 +00:00
advanced_topics Fix minor typo in the documentation - third party tutorial 2022-04-18 08:26:22 +10:00
contributing docs - fix spacing added between -m and http command 2022-04-03 22:12:04 +10:00
editor_manual documentation - migrate editor's guide to markdown from RST 2022-04-06 06:48:43 +10:00
extending Add trimmed to blocktrans tags. Fix #8217 (#8226) 2022-04-01 23:16:51 +01:00
getting_started Move wagtail.admin.edit_handlers to wagtail.admin.panels 2022-03-25 10:44:25 -04:00
reference Add base_url_path functionality to ModelAdmin 2022-04-18 14:32:18 +10:00
releases Cut down release note for image prefetching and add changelog entry 2022-04-14 12:56:04 +01:00
topics convert various documentation pages to Markdown 2022-04-18 08:16:27 +10:00
autobuild.sh
conf.py Pin sphinx-wagtail-theme==5.1.0 2022-04-07 18:53:52 +01:00
favicon.ico
index.rst Update links to wagtail.io website to point to wagtail.org 2022-01-15 20:23:44 +10:00
logo.png
Makefile Fix broken "make livehtml" command 2021-02-04 11:55:02 -08:00
README.md Update docs links to reference new domain 2022-01-15 20:04:24 +10:00
requirements.txt Update myst_parser to v0.17.2 (#8380) 2022-04-17 17:57:30 +01:00
robots.txt Update docs links to reference new domain 2022-01-15 20:04:24 +10:00
spelling_wordlist.txt
support.rst Update email addresses for new .org domain (#7845) 2022-01-28 12:16:24 +00: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 editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.