0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
Matt Westcott b8a9a2d319 Deprecate wagtail.contrib.modeladmin.menus.SubMenu in favour of wagtail.admin.menu.Menu
The Menu class was not originally designed to accept menu items at constructor time (instead requiring them to be passed via hooks); ModelAdmin's SubMenu class patched this functionality in, and the documentation for extending admin views piggybacked on this. Add this functionality to the base Menu class so that we don't have this unnecessary dependency on ModelAdmin.
2022-06-28 16:32:15 +10:00
..
_static Update screenshots in the editor guide's section for images 2022-06-01 16:50:25 +01:00
_templates
advanced_topics documentation - markdown formatting 2022-06-25 22:44:42 +10:00
contributing documentation - markdown formatting 2022-06-25 22:44:42 +10:00
editor_manual
extending Deprecate wagtail.contrib.modeladmin.menus.SubMenu in favour of wagtail.admin.menu.Menu 2022-06-28 16:32:15 +10:00
getting_started documentation - markdown formatting 2022-06-25 22:44:42 +10:00
reference documentation - markdown formatting 2022-06-25 22:44:42 +10:00
releases Deprecate wagtail.contrib.modeladmin.menus.SubMenu in favour of wagtail.admin.menu.Menu 2022-06-28 16:32:15 +10:00
topics documentation - markdown formatting 2022-06-25 22:44:42 +10:00
autobuild.sh
conf.py fix up spelling in documentation & docstrings (should be en-GB not en-US) 2022-05-13 08:13:06 +10:00
favicon.ico
index.rst
logo.png
Makefile
README.md auto-format core markdown files (#8603) 2022-06-01 23:08:56 +10:00
requirements.txt Update myst_parser to v0.17.2 (#8380) 2022-04-17 17:57:30 +01:00
robots.txt
spelling_wordlist.txt
support.md documentation - migrate docs/support to markdown 2022-06-28 16:16:09 +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 editor at http://rst.ninjs.org/ is a helpful tool for checking reStructuredText syntax.