0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
Commit Graph

482 Commits

Author SHA1 Message Date
Matt Westcott
b3c39216f2 Create a 'streamfield' subsection within the reference docs 2021-03-23 18:57:53 +00:00
Matt Westcott
f3e33f849f Convert StreamField reference to proper class definition markup 2021-03-23 18:57:53 +00:00
Matt Westcott
37c2326150 Split up StreamField documentation [skip ci] 2021-03-23 18:57:53 +00:00
Jaap Roes
8d0eff1717
Fix typo in hooks reference example (#6926) 2021-03-16 17:14:52 +00:00
Thibaud Colas
8b07ad4cea
Add support for SVG icons to SearchArea subclasses and register_admin_search_area (#6493) 2021-03-09 11:33:06 +00:00
Thibaud Colas
5257ef6c84
Update register_admin_menu_item documentation to match SVG icons setup (#6892) 2021-03-09 12:04:09 +01:00
naglis
73d41059f8
Fix typo in site settings documentation example (#6881)
Lowercase `i` is used in the model definition and in other examples.
2021-03-08 13:19:31 +00:00
Naomi I. Morduch Toubman
664b0489fe
Change master to main (#6830)
* Update references to `master` branch to say `main`

* Update external links

* Update links in old release notes
  Use tagged versions of code rather than current code
2021-03-03 13:33:19 -05:00
Andy Babic
fa8402f633 Implement PageQuerySet.defer_streamfields() 2021-03-03 13:03:46 +00:00
Andy Babic
8f38aaae87 Update type(), not_type(), exact_type() and not_exact_type() to accept multiple model classes as arguments 2021-03-02 20:00:28 +00:00
Storm Heg
24ef0e62e6 Fix documentation indentation
Fix code block indentation in tutorial.rst

Prevent it from being displayed as a quote.

Fix indentation in pages.rst

Fix indentation in indexing.rst

Fix indentation in searching.rst

Fix indentation in backends.rst

Fix indentation in renditions.rst

Fix indentation in custom_image_model.rst

Fix indentation in feature_detection.rst

Fix indentation in image_serve_view.rst

Fix indentation in custom_document_model.rst

Fix indentation in i18n.rst

Fix indentation in privacy.rst

Fix indentation in page_editing_interface.rst

Fix indentation in rich_text_internals.rst

Fix indentation in extending_hallo.rst

Fix indentation in configuration.rst

Fix indentation in usage.rst

Fix indentation in theory.rst

Fix indentation in model_reference.rst

Fix indentation in queryset_reference.rst

Configure editors to indent .rst files with 2 spaces

In order for the documentation to be styled correctly, the generator
depends on indentation. Too much indentation can result in the content
being wrapped in a quote block, which looks bad.

Fix indentation in sitemaps.rst

Fix indentation in frontendcache.rst

Fix indentation in routablepage.rst

Fix indentation in table_block.rst

Fix routablepage.rst autodocs disppearing

Fix indentation in table_block.rst

Fix indentation in redirects.rst

Fix indentation in table_documentation-modes.rst

Fix indentation in browser_issues.rst

Fix indentation in release_process.rst

Fix indentation of release notes

One more indent fix in the release notes

Fix indentation warnings

Fix warning about undefined label in docs

Error during `make html`:

  wagtail/docs/releases/1.7.rst:25: WARNING: undefined label: jpeg_image_quality
2021-02-26 09:17:00 +00:00
James Gutu
93abdabd41 moved jinja2 page from Advanced Topics to Reference 2021-02-04 12:12:11 -08:00
Matt Westcott
9886cb0476 add missing : to after_create_page example 2021-01-27 09:21:42 +00:00
Thibaud Colas
0dbd69f491
Configure Sphinx for Markdown support (#6711) 2021-01-26 22:09:52 +00:00
Matt Westcott
14daf4be0a Remove outdated versionadded/versionchanged notes in docs 2021-01-19 09:51:01 +00:00
Andy Babic
f905e705da Add Page.specific_deferred (#6661) 2021-01-18 13:25:55 +00:00
Matthias Rohmer
9a1fc6d243 Add missing import to example code snippet (#6638)
Adding this makes the code snippet ready to use via copy and paste.
2021-01-15 21:10:55 +00:00
LB
7737497239 fix JS code example in hooks docs
- when returning format_html `{` (brace) characters must be escaped
- https://docs.python.org/3/library/string.html#format-string-syntax
2021-01-15 13:18:15 +00:00
Luis Nell
a726c93df4 fix: signal receivers example raising exception
Signal receivers must accept `**kwargs`, otherwise one runs into this:

```
File "/lib/python3.8/site-packages/django/dispatch/dispatcher.py", line 94, in connect
raise ValueError("Signal receivers must accept keyword arguments (**kwargs).")
ValueError: Signal receivers must accept keyword arguments (**kwargs).
```
2021-01-11 11:25:19 +00:00
Bohreromir
3d18986610 fix ModelAdmin example (#6645) 2020-12-17 16:39:30 +00:00
Karl Hobley
45650053d5
Avoid recommending replacing image/document models entirely (#6624)
... when using the ``WAGTAILIMAGES_IMAGE_MODEL``/``WAGTAILDOCS_DOCUMENT_MODEL`` settings.

We can't really support this as we add new fields and methods to these base classes which all images/documents must support. If we did want to support swapping out the models entirely, every addition we make to the base models could be a breaking change.
2020-12-09 16:29:41 +00:00
Dan Braghis
05587e0d84 Allow customising image/document admin forms (#6462) 2020-12-09 12:35:19 +00:00
minusf
a18a36d820
Fix indentation of locked_by block in documentation (#6580) 2020-12-02 10:40:25 +00:00
Matt Westcott
6e1e36256a Remove elasticsearch 2 support 2020-11-05 12:04:12 +00:00
Naglis Jonaitis
74c692ba21 Fix ModelAdmin documentation example
The `get_extra_class_names_for_field_col` seems to have an `if` missing
and uses an undefined `balance`.
2020-11-03 13:49:18 +00:00
Loic Teixeira
6c9478c139 Rework headings hierarchy
Initial hierarchy:

- Available panel types
    - FieldPanel
    - StreamFieldPanel
    - MultiFieldPanel
    - InlinePanel
    - FieldRowPanel
    - HelpPanel
    - PageChooserPanel
    - ImageChooserPanel
    - FormSubmissionsPanel
    - DocumentChooserPanel
    - SnippetChooserPanel
        - Built-in Fields and Choosers
        - Field Customisation
    - Full-Width Input
    - Titles
    - Placeholder Text
    - Required Fields
    - Hiding Fields
        - Inline Panels and Model Clusters

Revised Hierarcy:

- Panel types
    - Built-in Fields and Choosers
        - FieldPanel
        - StreamFieldPanel
        - MultiFieldPanel
        - InlinePanel
        - FieldRowPanel
        - HelpPanel
        - PageChooserPanel
        - ImageChooserPanel
        - FormSubmissionsPanel
        - DocumentChooserPanel
        - SnippetChooserPanel
    - Field Customisation
        - Full-Width Input
        - Titles
        - Placeholder Text
        - Required Fields
        - Hiding Fields
    - Inline Panels and Model Clusters
2020-10-23 10:36:01 +01:00
David Bramwell
e28aa6b194 Document ModlelAdmin.prepopulated_fields 2020-10-19 21:36:05 +01:00
Karl Hobley
0efe4a75a5
[RFC 54] Internationalisation reference docs (#6377)
* Reference docs for internationalisation

* Update docs/reference/pages/model_reference.rst

Co-authored-by: Dan Braghis <dan@zerolab.org>

* Update docs/reference/pages/model_reference.rst

Co-authored-by: Dan Braghis <dan@zerolab.org>

* Update docs/reference/pages/model_reference.rst

Co-authored-by: Dan Braghis <dan@zerolab.org>

* Apply suggestions from code review

Co-authored-by: Dan Braghis <dan@zerolab.org>

* Add missing comma

* Apply suggestions from code review

Co-authored-by: Matt Westcott <matthew@torchbox.com>

Co-authored-by: Dan Braghis <dan@zerolab.org>
Co-authored-by: Matt Westcott <matthew@torchbox.com>
2020-10-19 18:40:58 +01:00
Matt Westcott
9fab50e87a remove trailing whitespace 2020-10-19 18:11:12 +01:00
Jean Zombie
b5cfca31eb Add example of updating a page within after_create_page (#6373)
This update intends to add the answer I got on my slack support request (https://wagtailcms.slack.com/archives/C81FGJR2S/p1599209092087000).
2020-10-19 18:01:49 +01:00
Karl Hobley
7f7f9b4de1 Make snippets action menu hookable 2020-10-14 14:41:22 +01:00
Karl Hobley
c170c50c78 Add view for converting aliases into regular pages 2020-10-08 10:24:58 +01:00
Karl Hobley
b5eddca28b Synchronise alias page content when the source is updated 2020-10-08 10:24:58 +01:00
Karl Hobley
674fa8e27a Add Page.create_alias method 2020-10-08 10:24:58 +01:00
Karl Hobley
17f63f0efc Add alias_of field to Page 2020-10-08 10:24:58 +01:00
Matt Westcott
dd442a3990 remove trailing whitespace to placate doc8 2020-10-05 12:44:57 +01:00
meghanabhange
f1fbbcbc24
Add validation for file extension in AbstractDocument using WAGTAIL_DOCS_EXTENSIONS setting (#6423) 2020-10-05 12:26:00 +01:00
Karl Hobley
cf38b2457d Put quotes around some inline code 2020-10-03 14:43:03 +01:00
Karl Hobley
39d931d77d Javascript => JavaScript 2020-10-03 14:43:03 +01:00
Karl Hobley
6e5f89adf2 General spelling fixes 2020-10-03 14:43:03 +01:00
Karl Hobley
9195131738 Lint docs with doc8 2020-10-03 14:43:03 +01:00
Ameet Virdee
48a8af71e5 Add documentation for placeholder text in Field Panels 2020-10-01 08:06:43 +02:00
Matt Westcott
008b6c12c4 Update BaseLogEntry docs to reference user_display_name. Fixes #6418 2020-09-30 15:43:27 +01:00
Matt Westcott
8edf16e5ff Serve PDFs inline in the browser
Fixes #1158
Add config options WAGTAILDOCS_CONTENT_TYPES and WAGTAILDOCS_INLINE_CONTENT_TYPES to determine the Content-Type and Content-Disposition headers returned for documents when using the Django serve view, and default to application/pdf being served inline.
2020-09-28 07:22:58 +10:00
Scott Cranfill
70bb9d934b
Support SVG icons in ModelAdmin menu items (#6402)
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2020-09-25 15:58:52 +01:00
Andy Babic
8fd5d66756 Add RoutablePage.render() helper method and update documentation 2020-09-01 22:24:08 +01:00
Matt Westcott
a1f882b7c9 Convert remaining gettext .format strings to old-style string formatting
As per #5548 / #6238. Fixes #6343
2020-08-21 13:26:00 +01:00
Matt Westcott
8542f5fe9c Fix underline lengths to prevent Sphinx warnings 2020-08-07 17:23:42 +01:00
jacobtoppm
e85f16b500 Add a use case example for WAGTAIL_WORKFLOW_CANCEL_ON_PUBLISH=False 2020-08-07 17:10:24 +01:00
Karl Hobley
9ad14ea439
Add hooks for snippet listing buttons 2020-08-07 15:47:27 +01:00