0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-30 01:46:24 +01:00
Commit Graph

175 Commits

Author SHA1 Message Date
Matt Westcott
37784643e9 API docs for Panel 2022-04-22 17:25:30 +01:00
Daniel Kirkham
c877bf9886 convert various documentation pages to Markdown
- Removes use of topic:: in docs as this directive is not needed
- resolves #8323
2022-04-18 08:16:27 +10:00
Matt Westcott
6d2dcee4b9
Remove a stray reference to ChooserPanels (#8360)
These are no longer required in Wagtail 3
2022-04-14 11:09:31 +01:00
Abdul
9007bda686 documentation - add admin tag manager doc
- add documentation that describes how to use `ModelAdmin` to manage tags
- resolves #1220
2022-04-06 07:21:34 +10:00
Matt Westcott
97e781e31c Renumber Wagtail 2.17 to 3.0
As per discussion on https://github.com/wagtail/wagtail/discussions/7732, the changes in the upcoming release (sidebar redesign, removal of hallo.js, module reorganisation) warrant a version bump to 3.0 if we're following semantic versioning.
2022-03-31 06:38:27 +10:00
Matt Westcott
6bb26c774e Move template paths from edit_handlers to panels 2022-03-25 10:44:25 -04:00
Matt Westcott
c7774ba0be Move wagtail.contrib.forms.edit_handlers to wagtail.contrib.forms.panels 2022-03-25 10:44:25 -04:00
Matt Westcott
b189ab8382 Move wagtail.admin.edit_handlers to wagtail.admin.panels 2022-03-25 10:44:25 -04:00
Karl Hobley
75cc7da38a Move wagtail.core to wagtail 2022-03-17 17:19:59 +00:00
Matt Westcott
dd37901428 Add documentation for the permission kwarg on FieldPanel 2022-03-16 11:47:51 +00:00
LB (Ben Johnston)
70aabb5d34
Refine documentation for show_in_menus (#8072)
- this appears to be a point of confusion, where developers are unsure what this field does
- this update makes it more explicit that this field does not do anything, except the queryset usage, by default
2022-03-04 14:34:21 +00:00
Matt Westcott
31139e8b24 Remove references to StreamFieldPanel and ChooserPanels from docs 2022-03-02 15:55:25 +00:00
Sage Abdullah
bf8d5b3f94 Replace data_json TextField with data JSONField in BaseLogEntry 2022-02-28 10:27:07 +00:00
Sage Abdullah
bae76a2af0 Replace content_json TextField with content JSONField in PageRevision 2022-02-25 11:39:47 +00:00
Andy Babic
2c33c98eb4 Remove redirect auto-creation recipe from docs, as wagtail has this covered. 2022-02-22 16:18:46 +10:00
Andy Babic
236af3607f Documentation for #7827 2022-01-21 12:53:37 +00:00
Karl Hobley
6f2c576da0
Revert "Add ever_live() and never_live() filters to PageQuerySet (RFC 34) (2 of 3)" (#7796)
* Revert "Release notes for #7776"

This reverts commit a7e58e9c67.

* Revert "Tests for #7776"

This reverts commit 1f5734ce3f.

* Revert "Add PageQuerySet.ever_live() and PageQueryset.never_live() filters"

This reverts commit d8c2e33505.
2021-12-18 16:54:26 +00:00
Andy Babic
d8c2e33505 Add PageQuerySet.ever_live() and PageQueryset.never_live() filters 2021-12-16 14:10:16 +00:00
Victor Miti
bb802509d2 Model Reference docs - correct field name
change `page revision` to `page_revision`
on the `TaskState` model
2021-09-26 20:46:29 +10:00
Tibor Leupold
9ae4ab6084 Document how to limit a page parent to root
Closes #2768

Issue #2768 was created because a way how to limit a page to be only
available under the root page was unknown.

The implementation has allowed this for a while now, but the issue was
not closed (presumably due to missing documentation).

The documentation of the `parent_page_types` filed now includes this
"special" case.
2021-09-07 09:52:33 +01:00
fabienheureux
cb08c997ea
Make all edit panels collapsible (#7365)
* Make more panels type collapsible
* Remove duplicate js in homepage template
* Move collapsible code into its own js file
* Change $li to $target in collapsible.js, as in #6342

Closes #7364, #6342, #6187, #2123

Co-authored by: Fabien Le Frapper <contact@fabienlefrapper.me>
Co-authored-by: Robbie Mackay <rm@robbiemackay.com>
Co-authored-by: Scott Cranfill <scott.cranfill@jpl.nasa.gov>
2021-08-30 08:33:43 -07:00
Andy Chosak
e9e1a48b68 Fix broken references in Pages topic documentation
The "Page models" documentation page in the Wagtail usage guide has
several broken links (see current page at
https://docs.wagtail.io/en/stable/topics/pages.html).

These links work when developing the documentation locally, but not when
served on ReadTheDocs (docs.wagtail.io)

The broken links are all of the form /some/page.html#anchor - somehow
this format doesn't translate properly to get the necessary RTD prefix
(for example /en/stable/).

I've modified these links to use RST references, which will also make
them more robust to future changes.
2021-08-20 17:08:35 +01:00
jacobtoppm
59f63abdad Add documentation for commenting 2021-04-30 17:46:08 +01: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
Andy Babic
f905e705da Add Page.specific_deferred (#6661) 2021-01-18 13:25:55 +00:00
minusf
a18a36d820
Fix indentation of locked_by block in documentation (#6580) 2020-12-02 10:40:25 +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
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
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
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
e0dc53d9ad Remove versionadded/versionchanged notes for 2.9 2020-07-28 12:53:22 +01:00
jacobtoppm
c79668929e Update reference documentation, custom task guide, and release notes, and fix documentation build errors 2020-07-24 16:59:33 +01:00
Matt Westcott
bf53123309 Fix sphinx warnings from workflow / audit log documentation 2020-07-24 16:59:33 +01:00
Dan Braghis
f69287f6f4 Add documentation 2020-07-24 16:59:33 +01:00
jacobtoppm
df3a63c7a2 Add new page methods and updated workflow state methods 2020-07-24 16:59:33 +01:00
jacobtoppm
8911bd30d7 Add workflow models to reference 2020-07-24 16:59:33 +01:00
Andy Babic
dd680ae4d4 Factor out content type fetching into a separate Page method, simplify the specific specific_class methods, and improve docstrings 2020-07-13 18:25:11 +01:00
Tom Dyson
20b99d4386
Remove 'whitelist' from page reference docs (#6153) 2020-06-16 11:23:51 +01:00
Brylie Christopher Oxley
ff37ad6ab9 Add 'add_redirect' static method to Redirect
* This method was inspired by a Lacey Williams Henschel (@williln) presentation at Wagtail Space US 2018, called  'What the Wagtail docs don't tell you'. https://www.youtube.com/watch?v=PCkxBNXWM64&t=1220s
* Add docs section reference/contrib/redirects
2020-05-10 18:48:33 +10:00
LB (Ben Johnston)
9359b14326
fix sphinx warnings (#6001)
- use .add_css_file instead of .add_stylesheet in conf.py
- use .add_js_file instead of .add_javascript in conf.py
- fix duplicate clss references in pages model reference (for grouping of methods & attributes)
- rename wagtailspace.js to banner.js (may be used in the future for a generic banner)
2020-05-03 14:02:43 +02:00
danbentley
1156182283
Add Page.context_object_name (#5999)
Page.context_object_name can be used to define a more meaningful name
for the page variable in the template.

If defined, the default `page` and `self` are still available for use in
shared templates.

Resolves #5213
2020-05-01 20:01:02 +02:00
jacobtoppm
12d5edcef6 Add heading option to panels reference 2020-03-19 16:10:30 +00:00
Matt Westcott
09a2ccf8cc Documentation for custom tag models 2020-02-26 14:10:21 +00:00
Matt Westcott
4950158e46 Remove remaining references to request.site 2020-02-17 12:06:19 +00:00