0
0
mirror of https://github.com/wagtail/wagtail.git synced 2024-11-22 11:07:57 +01:00
Commit Graph

938 Commits

Author SHA1 Message Date
Sage Abdullah
f54b03d595
Use intersphinx to link to treebeard docs 2024-11-05 10:44:41 +00:00
Sage Abdullah
503d1a743a
Replace hardcoded Python docs links with intersphinx 2024-11-05 10:44:40 +00:00
Sage Abdullah
5615deb5b1
Add Django's custom Sphinx roles and use them to link to settings
This is necessary for rST docs, i.e. in docstrings and in eval-rst
blocks. Without this, Sphinx cannot seem to understand the role. See:
https://stackoverflow.com/questions/13387125

MyST-Parser seems to be smarter, it can figure out these custom
roles without having to register the types ourselves. This is evident in
the previous commits where I already use the :setting: role in markdown
docs.
2024-11-05 10:44:40 +00:00
Sage Abdullah
9a5be8f180
Replace more hardcoded Django links with intersphinx in rST docs
Some link labels are changed to just the code part, because using Sphinx
roles for code objects (e.g. methods, attributes) would always format the
text as inline code.

It's currently impossible to customize the formatting of a link's text in
rST. See https://stackoverflow.com/questions/4743845
2024-11-05 10:44:39 +00:00
Sage Abdullah
857b26e5a0
Replace hardcoded Django docs links to intersphinx links 2024-11-05 10:44:39 +00:00
Aayushman Singh
7f6e7d4062 Docs - Improve hooks & extending pages with CSP compliant examples
- Avoid `mark_safe` and use `format_html` where possible
- Avoid inline scripts, instead ensure the example shows external script usage
2024-11-02 10:29:19 +10:00
Ayaan
0913118da4
Replaced Twitter references in the docs with more appropriate alternatives (#12516). Fix #12483
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2024-11-01 11:03:54 +00:00
Matt Westcott
593b95cad9
Document the ability to migrate from ImageChooserBlock to ImageBlock (#12518) 2024-11-01 09:58:42 +00:00
LB
3a5ae9c695 Docs - Ensure core models module level docstring does not appear in docs
Avoid the docstring being shared in the model reference documentation, this content is for core development only.
Update name of core modules.
2024-10-29 15:47:39 +00:00
Srishti-j18
fd9b1ca22b Docs - Update spelling to US customize variants
Fixes #12476
2024-10-29 18:47:43 +10:00
Srishti-j18
652de3fcb3 Documentation - Improve code highlighting & formatting for Python docstrings in core models 2024-10-28 08:34:38 +10:00
Andy Babic
e451bbd96a Support application of select_related and prefetch_related lookups to subqueries made by SpecificIterable
- Add queryset methods to reference docs, and provide performance considerations for prefetch_related()
2024-10-28 08:06:03 +10:00
activus-d
97a1f5aabd Documentation - Improve project template (wagtail start) & add to management commands reference
Fixes #11938

* Add `wagtail start` to the management commands reference
* Add detail on how to creating templates with the need to escape template syntax by using the verbatim tag
2024-10-25 21:15:30 +10:00
LB
fa81e2dbbe Docs - update spelling to US 'customizations' 2024-10-25 21:14:52 +10:00
Srishti-j18
2d644dd8e2 Documentation - Move tags out from pages model recipes to a standalone advanced topic 2024-10-25 20:30:12 +10:00
Srishti-j18
f588fcf249 Documentation - Reposition model & panel references
- Move model reference to directly under the references section, not the reference/pages section
- Move panel reference to directly under the references section, not the reference/pages section
- Merge panel API with panels reference pages
- Fix confusing heading levels in the page model recipes page
- Fix title in model reference to align with docs style guide
- Adopt US spelling for customize (panels) reference key
2024-10-25 20:30:12 +10:00
Matt Westcott
bbb50459c9 Remove versionadded / versionchanged notes for 6.2
However, leave behind notes that mark settings/features that are deprecated but not yet removed, as this would be removing information that isn't in the main body of the text (and moving it out of a versionchanged note would make it harder to find when we come to remove it properly in 7.0).
2024-10-23 16:45:46 +10:00
Matt Westcott
93f8600c31
ImageBlock for StreamField (rebase of #11791) (#12416)
Co-authored-by: Chiemezuo <chiemezuoakujobi@gmail.com>
Co-authored-by: Thibaud Colas <thibaudcolas@gmail.com>
2024-10-21 16:11:34 +01:00
Sage Abdullah
5909d3e822
Apply suggestions from code review 2024-10-18 18:19:18 +01:00
alexkiro
b38141ad82
Allow customization of preview device sizes
Co-authored-by: Bartosz Cieliński <bart@fullfatthings.com>
2024-10-18 18:19:17 +01:00
Coen van der Kamp
abcb2da372 Add translatable model copy for translation done signal (#12362) 2024-09-27 16:01:52 +01:00
Matt Westcott
5aa0673452 Update WAGTAIL_WORKFLOW_REQUIRE_REAPPROVAL_ON_EDIT docs to indicate that default is False (#12340)
Fixes #12329
2024-09-19 16:41:17 +01:00
Sage Abdullah
706b95f670 Deprecate the WAGTAIL_AUTO_UPDATE_PREVIEW setting 2024-09-19 08:22:54 +10:00
LB Johnston
4af8ab528b Documentation - formatting clean up 2024-08-29 18:32:20 +01:00
LB Johnston
1790bdd158 Align recent docs & release notes to US spelling 2024-08-29 18:28:07 +01:00
Vince Salvino
067ebc01ec Add example date/time formatting for the Wagtail admin settings. (#12083) 2024-08-02 13:54:13 +01:00
Sage Abdullah
dfe9638e7d Replace pytz.common_timezones with zoneinfo.available_timezones
and remove pytz dependency
2024-07-29 18:31:30 +01:00
Matt Westcott
f7fa20e600 Upgrade Sphinx to 7.3; use newer syntax for no-index directive and --fail-on-warning switch 2024-07-23 10:13:03 +01:00
Matt Westcott
0e60590676 Fix no-index directive for Sphinx 7.4.7 2024-07-22 14:21:16 +01:00
Matt Westcott
e1f9d97238 Remove versionadded/versionchanged notes for 6.1 2024-07-22 13:43:34 +01:00
Thibaud Colas
c569e08d7d Release notes for #12099 2024-07-19 13:14:30 +01:00
Sage Abdullah
f8564055b1 Add WAGTAIL_EDITING_SESSION_PING_INTERVAL setting 2024-07-19 13:14:30 +01:00
Matt Westcott
a7d72f9fbf Fix formatting errors 2024-07-19 00:21:39 +01:00
Chris Shenton
d1c020cd5f Fix Page.copy ref; silence warnings due to Sphinx missing support for type hints
Builds upon HimanshuGarg47:fix/11972-documentation-build-with-errors
2024-07-18 23:15:58 +01:00
Himanshu Garg
9adf742580 fixes errors by adding aliases, double backtick, changing indexentry 2024-07-18 23:15:40 +01:00
Himanshu Garg
e02ca6ce62 fixes some of errors by removing directives 2024-07-18 23:13:26 +01:00
smark-1
95eac5ab78
Allow page to change private page options 2024-07-18 17:23:30 +01:00
Sage Abdullah
f126a4860e Deprecate user form-related settings 2024-07-10 17:10:36 +02:00
Sage Abdullah
449a48d7f9 Reorganise docs for custom user forms to prefer UserViewSet customisation
And make small tweaks to the GroupViewSet docs so the custom apps
examples align.
2024-07-10 17:10:36 +02:00
Andy Chosak
a81cabce05 Expose URL resolver match for RoutablePageMixin (#11953)
Django provides an `HttpRequest.resolver_match` attribute [0] that
allows downstream code to inspect a request object to see how its URL
was resolved to a view.

Wagtail's RoutablePageMixin does its own sub-URL routing to call
different view functions on a page object, but the resolver result isn't
similarly made available.

This commit sets a new `routable_resolver_match` attribute on the
request object, akin to Django's `resolver_match`, that stores this
sub-URL routing information for downstream use.

Documentation has been updated appropriately (along with a couple of
other minor broken things in the RoutablePageMixin docs).

[0] https://docs.djangoproject.com/en/5.0/ref/request-response/#django.http.HttpRequest.resolver_match
2024-07-03 14:17:12 +01:00
Sage Abdullah
b3e87bcee8
Register permissions for models registered with ModelViewSet 2024-07-02 09:30:57 +01:00
Jake Howard
15511411bd Allow manually specifying credentials for CloudFront frontend cache backend (#10565) 2024-07-01 19:02:12 +01:00
Sage Abdullah
e1b77ccd6f Add docs about not converting relative links when there are multiple sites 2024-06-25 17:59:37 +01:00
Arnar Tumi Þorsteinsson
c700ed67ef Copy for translations done signal and test (#12033) 2024-06-12 15:41:04 +02:00
Byron Peebles
e36c4d3fba Documentation: Update some Sphinx-style code ref roles to MyST style (#12030) 2024-06-12 11:47:06 +02:00
smark-1
5c85c127e6 add docs for page view restriction (#11917) 2024-05-03 15:33:16 +01:00
Matt Westcott
617e5129c5
Add management command to fix UUID fields under MariaDB / Django 5.0 (#11912) 2024-05-01 11:07:20 +01:00
Matt Westcott
7900055afa Release note for #11858 2024-04-24 23:55:22 +01:00
Jake Howard
c00c2b684f Allow frontend caching backends to limit which hostnames they respond to 2024-04-24 23:34:33 +01:00
Sage Abdullah
fd659ae767
Remove versionadded / versionchanged annotations for 6.0 2024-04-22 09:00:36 +07:00