0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-29 09:33:54 +01:00
wagtail/docs
Matt Westcott a6a94a9a04 Ensure DocumentChooserBlock can be deconstructed for migrations
Fixes #8989. Now that DocumentChooserBlock is constructed dynamically via wagtail.documents.viewsets.chooser, we need to explicitly set its `__module__` attribute so that the result of calling `deconstruct()` for migrations points back to the wagtail.documents.blocks module.

Also update the documentation for defining custom choosers, and add tests for deconstructing the other chooser blocks.
2022-08-15 15:38:54 -04:00
..
_static Add pagination to docs search results page (#8178) 2022-07-15 13:35:26 +01:00
_templates replace latin abbreviations with english phrases & updated docs guidelines 2022-07-20 16:11:38 +10:00
advanced_topics Update InlinePanel and StreamField styles for new designs (#8983) 2022-08-12 13:17:40 +01:00
contributing replace latin abbreviations with english phrases & updated docs guidelines 2022-07-20 16:11:38 +10:00
editor_manual Update chooser styles across all types 2022-08-10 15:08:57 +10:00
extending Ensure DocumentChooserBlock can be deconstructed for migrations 2022-08-15 15:38:54 -04:00
getting_started Finish re-implementing form styles based on design feedback & code review 2022-08-05 10:36:52 +02:00
reference Update InlinePanel and StreamField styles for new designs (#8983) 2022-08-12 13:17:40 +01:00
releases Ensure DocumentChooserBlock can be deconstructed for migrations 2022-08-15 15:38:54 -04:00
topics Update InlinePanel and StreamField styles for new designs (#8983) 2022-08-12 13:17:40 +01:00
autobuild.sh
conf.py replace latin abbreviations with english phrases & updated docs guidelines 2022-07-20 16:11:38 +10: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
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 Update docs links to reference new domain 2022-01-15 20:04:24 +10:00
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.