0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
wagtail/docs
Tibor Leupold adc2ea6a86
Use RichText object for adding rich text blocks (#8675)
I have just tried to follow the original instructions and got an `AttributeError: 'str' object has no attribute 'source'` when trying to append a rich text block to a `StreamField` programmatically. 

Wrapping the value in a `RichText` object solved the issue. This seems to be in line with the behavior described further down the page.
2022-06-16 16:06:09 +02:00
..
_static Update screenshots in the editor guide's section for images 2022-06-01 16:50:25 +01:00
_templates Indent templates with djhtml 2022-02-12 01:15:51 +00:00
advanced_topics Changelog/release note for #8686 2022-06-16 10:10:00 +01:00
contributing fix spelling - behaviour vs behavior 2022-06-02 07:56:05 +10:00
editor_manual documentation - migrate editor's guide to markdown from RST 2022-04-06 06:48:43 +10:00
extending Update example code - Adding a group of menu items (#8683) 2022-06-16 12:01:06 +02:00
getting_started fix up spelling in documentation & docstrings (should be en-GB not en-US) 2022-05-13 08:13:06 +10:00
reference Put headers in markdown rather than rst 2022-06-12 15:47:24 +10:00
releases Add release dates to release notes (#8692) 2022-06-16 14:04:18 +02:00
topics Use RichText object for adding rich text blocks (#8675) 2022-06-16 16:06:09 +02: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 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.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.