59f63abdad
Add documentation for commenting
2021-04-30 17:46:08 +01:00
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
f905e705da
Add Page.specific_deferred ( #6661 )
2021-01-18 13:25:55 +00:00
a18a36d820
Fix indentation of locked_by block in documentation ( #6580 )
2020-12-02 10:40:25 +00:00
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
b5eddca28b
Synchronise alias page content when the source is updated
2020-10-08 10:24:58 +01:00
674fa8e27a
Add Page.create_alias method
2020-10-08 10:24:58 +01:00
17f63f0efc
Add alias_of field to Page
2020-10-08 10:24:58 +01:00
008b6c12c4
Update BaseLogEntry docs to reference user_display_name. Fixes #6418
2020-09-30 15:43:27 +01:00
e0dc53d9ad
Remove versionadded/versionchanged notes for 2.9
2020-07-28 12:53:22 +01:00
c79668929e
Update reference documentation, custom task guide, and release notes, and fix documentation build errors
2020-07-24 16:59:33 +01:00
bf53123309
Fix sphinx warnings from workflow / audit log documentation
2020-07-24 16:59:33 +01:00
f69287f6f4
Add documentation
2020-07-24 16:59:33 +01:00
df3a63c7a2
Add new page methods and updated workflow state methods
2020-07-24 16:59:33 +01:00
8911bd30d7
Add workflow models to reference
2020-07-24 16:59:33 +01:00
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
20b99d4386
Remove 'whitelist' from page reference docs ( #6153 )
2020-06-16 11:23:51 +01:00
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
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
f34891fbd3
Update docs to cover wagtail_site tag, find_for_request and deprecation of SiteMiddleware
2020-02-17 12:06:18 +00:00
5eec4d954e
Deprecate SiteMiddleware ( #3834 , #5332 , #5673 )
...
Squashed commit of the following:
commit 6ff78d0271ae9bb8be20edc77acc046b7ecd1190
Merge: cbb5575b7872e3cbb5575fd86188742cfe4b4dee61c1341e4b4dee6c47540dff380b4a934240d2442fhttps://github.com/aritas1/wagtail into aritasmaster
commit 0d2442fc1fb7e6b8e655b16250fce94be243f64d33151817a038b304105af745aae9d0
2020-02-17 12:06:18 +00:00
dd4a04f843
Skip field validation when unpublishing pages.
2020-02-16 21:05:51 +00:00
99cb3154cc
Correct model reference for page, page cannot be edited when locked is True, rather than False
2020-01-02 09:41:42 +00:00
5f68627950
Merge branch 'master' into author-specific-locking
2019-11-26 15:55:49 +00:00
229103ff2e
Update links in documentation. ( #5689 )
...
Use HTTPS links instead of non-secure HTTP links wherever possible in
documentation.
2019-11-08 09:15:01 +00:00
ed32bc8444
fixup! Record time and user when a page is locked
2019-10-28 11:16:54 +00:00
67213d7286
Record time and user when a page is locked
2019-10-16 14:26:04 +01:00
d008cc7e21
Implement Page.with_content_json and add to docs ( fixes #5199 )
2019-06-20 16:24:04 +01:00
c831d434ab
Added an option to the page model to be able to define the amount of subpages underneath a specific parent page
2019-03-15 18:14:05 +01:00
47465197a9
Use intersphinx for Django references when possible. ( #4896 )
2018-11-14 11:48:32 +00:00
3b1dc5be86
Add Page max_count
2018-10-27 15:13:16 +03:00
8d786c3534
Reference the `get_url` method in Page model reference docs
...
Fixes #4424 . As of #3354 , `get_url` is the preferred way of obtaining a page URL, rather than the `.url` property;
.url is just a wrapper around get_url (which meant that the docstring for `get_url` was erroneously being picked up).
2018-05-18 15:26:06 +01:00
c38b172793
updated Django Docs Links to point to *docs.djangoproject.com/en/stable/*
2018-05-18 14:43:42 +01:00
c85e4a3ff0
add note for setting menu default globally ( #4244 )
2018-02-06 14:10:45 +00:00
062d05189b
Rename wagtail.wagtailadmin to wagtail.admin
...
Conflicts:
docs/advanced_topics/customisation/admin_templates.rst
docs/advanced_topics/customisation/page_editing_interface.rst
docs/advanced_topics/i18n/duplicate_tree.rst
docs/advanced_topics/jinja2.rst
docs/advanced_topics/settings.rst
docs/getting_started/integrating_into_django.rst
docs/getting_started/tutorial.rst
docs/reference/hooks.rst
docs/reference/pages/panels.rst
docs/topics/pages.rst
docs/topics/streamfield.rst
wagtail/admin/blocks.py
wagtail/admin/checks.py
wagtail/admin/edit_handlers.py
wagtail/admin/forms.py
wagtail/admin/rich_text.py
wagtail/admin/search.py
wagtail/admin/site_summary.py
wagtail/admin/templatetags/wagtailadmin_tags.py
wagtail/admin/tests/test_admin_search.py
wagtail/admin/tests/test_buttons_hooks.py
wagtail/admin/tests/test_compare.py
wagtail/admin/tests/test_edit_handlers.py
wagtail/admin/tests/test_page_chooser.py
wagtail/admin/tests/test_pages_views.py
wagtail/admin/tests/test_rich_text.py
wagtail/admin/tests/test_widgets.py
wagtail/admin/tests/tests.py
wagtail/admin/urls/__init__.py
wagtail/admin/views/account.py
wagtail/admin/views/chooser.py
wagtail/admin/views/collection_privacy.py
wagtail/admin/views/collections.py
wagtail/admin/views/home.py
wagtail/admin/views/page_privacy.py
wagtail/admin/viewsets/model.py
wagtail/admin/wagtail_hooks.py
wagtail/admin/widgets.py
wagtail/contrib/settings/registry.py
wagtail/contrib/wagtailsearchpromotions/wagtail_hooks.py
wagtail/contrib/wagtailstyleguide/wagtail_hooks.py
wagtail/project_template/project_name/settings/base.py
wagtail/project_template/project_name/urls.py
wagtail/tests/non_root_urls.py
wagtail/tests/settings.py
wagtail/tests/snippets/models.py
wagtail/tests/testapp/models.py
wagtail/tests/testapp/wagtail_hooks.py
wagtail/tests/urls.py
wagtail/wagtaildocs/models.py
wagtail/wagtaildocs/views/chooser.py
wagtail/wagtaildocs/wagtail_hooks.py
wagtail/wagtailembeds/wagtail_hooks.py
wagtail/wagtailforms/models.py
wagtail/wagtailforms/tests/test_views.py
wagtail/wagtailforms/views.py
wagtail/wagtailforms/wagtail_hooks.py
wagtail/wagtailimages/models.py
wagtail/wagtailimages/views/chooser.py
wagtail/wagtailimages/wagtail_hooks.py
wagtail/wagtailredirects/forms.py
wagtail/wagtailredirects/wagtail_hooks.py
wagtail/wagtailsites/forms.py
wagtail/wagtailsites/views.py
wagtail/wagtailsites/wagtail_hooks.py
wagtail/wagtailsnippets/tests.py
wagtail/wagtailsnippets/wagtail_hooks.py
wagtail/wagtailusers/forms.py
wagtail/wagtailusers/views/groups.py
wagtail/wagtailusers/wagtail_hooks.py
2017-11-26 22:43:47 +00:00
4300e19da2
Rename wagtail.wagtailcore to wagtail.core
2017-11-26 22:43:47 +00:00
48b6a1b067
add note about django-treebeard api
2017-11-12 18:13:23 +00:00
cd924d0948
add docs for exclude_fields_in_copy
2017-11-10 11:02:55 +00:00
70aa876e55
Extra documentation / release note re the relationship between draft_title and get_admin_display_title
2017-08-03 12:05:52 +01:00
18cb0245fc
allow default for show_in_menus
2017-06-09 12:50:39 +01:00
927770eaab
Release note / docs for #3608
2017-06-02 10:58:34 +01:00
ee837dedc5
in Page reference docs, don't tell people to consult source code ( #3303 )
...
Stylistically this sentence is somewhat content-free (if the API is really "relatively straightforward", users can see that for themselves rather than us informing them of that fact...), and we don't want to encourage people to use undocumented methods (because we can't guarantee that the API for them will remain stable).
2017-01-28 00:11:52 +00:00
6402e56fb5
Update model_reference.rst
2017-01-26 20:05:35 +00:00
8a3c47f76a
Use get_admin_display_title in admin
2016-10-13 15:46:12 +01:00
90552bedb5
Fix site ref in docs
2016-10-01 22:04:46 +03:00
9dcc12ac55
Fix a typo in model reference
2016-05-10 14:28:34 +01:00
b727ec4064
Add documentation on the base_form_class attribute
2016-05-03 14:00:21 +01:00
33aad3957f
Fix internal links with anchors
...
Generating links with `link text <./path/to/doc#anchor>`__ does not work for html.
It produces a link to `./path/to/doc#anchor` instead of `./path/to/doc.html#anchor`.
It would be tempting to add `.html` before `#` but would likely cause some more issues
when generating the documentation as pdf or epub.
References on the other hand will work regardless of the output format.
2016-03-06 21:05:05 +00:00
7861c2b492
Add get_site and get_url_parts to the Page model reference docs
2016-03-01 12:11:14 +00:00
88d1977d34
Document `site_name` attribute of Site - fixes #2099
2016-01-13 12:49:46 +00:00
jacobtoppm