Documentation - fix streamfield reference issue

- myst was building a doc link `streamfield` and also had a ref link `streamfield` which was causing conflicts
pull/8780/head
LB Johnston 2022-06-30 09:12:35 +10:00 zatwierdzone przez LB (Ben Johnston)
rodzic 4e7accda55
commit 86cb09a534
3 zmienionych plików z 4 dodań i 4 usunięć

Wyświetl plik

@ -2,12 +2,12 @@
# StreamField block reference
This document details the block types provided by Wagtail for use in [StreamField](../../topics/streamfield.rst), and how they can be combined into new block types.
This document details the block types provided by Wagtail for use in [StreamField](streamfield), and how they can be combined into new block types.
```{eval-rst}
.. class:: wagtail.fields.StreamField(blocks, use_json_field=None, blank=False, min_num=None, max_num=None, block_counts=None, collapsed=False)
A model field for representing long-form content as a sequence of content blocks of various types. See :ref:`streamfield`.
A model field for representing long-form content as a sequence of content blocks of various types. See :ref:`streamfield_topic`.
:param blocks: A list of block types, passed as either a list of ``(name, block_definition)`` tuples or a ``StreamBlock`` instance.
:param use_json_field: When true, the field uses :class:`~django.db.models.JSONField` as its internal type, allowing the use of ``JSONField`` lookups and transforms. When false, it uses :class:`~django.db.models.TextField` instead. This argument **must** be set to ``True``/``False``.

Wyświetl plik

@ -15,7 +15,7 @@ What's changed
StreamField - a field type for freeform content
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
StreamField provides an editing model for freeform content such as blog posts and news stories, allowing diverse content types such as text, images, headings, video and more specialised types such as maps and charts to be mixed in any order. See :ref:`streamfield`.
StreamField provides an editing model for freeform content such as blog posts and news stories, allowing diverse content types such as text, images, headings, video and more specialised types such as maps and charts to be mixed in any order. See :ref:`streamfield_topic`.
Wagtail API - A RESTful API for your Wagtail site

Wyświetl plik

@ -1,4 +1,4 @@
(streamfield)=
(streamfield_topic)=
# How to use StreamField for mixed content