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

58 Commits

Author SHA1 Message Date
LB Johnston
145e33de9d
5.2 release notes - add supporting links and fix typos 2023-10-20 10:13:27 +01:00
rohitsrma
15642124b6 API - Allow ordering by multiple fields
- Closes #7429
- Builds on original PR #7433 (Jake Howard)
2023-10-09 22:16:31 +11:00
Neeraj P Yetheendran
cdd6f1800c Allow subclasses of PagesAPIViewSet override default Page model
- Built on original PR #7372 and feedback on that solution
- Add unit tests and documentation
- Fix typo in API documentation for `CustomPagesAPIViewSet`
- Ensure that pk is used (not id) while filtering to prevent assumption that id is pk
2023-09-20 08:13:19 +10:00
LB Johnston
aa9e9cddc7 Resolve multiple typos (spelling and grammar)
- Optimized/Customized/Catregorize -> Optimised/Customised/Categorise
- Github -> GitHub (80% were spelt with capital H, this is the way GitHub spells itself)
- GitPod -> Gitpod (most were without the capital P, Gitpod's site does not use capital P)
- Remove duplicate words (to to, the the)
- De-coupled -> decoupled
- implementors -> implementers (all other references used 'site implementers' so just aligning with the common case)
- Fix a/an usage in one case
- Fix one comment usage of ok, replace with OK
2023-05-30 21:07:37 +10:00
Joshua Munn
196ed4162d Add SVG docs 2023-03-30 10:19:43 +01:00
Matt Westcott
18a574b520 Remove old versionadded / versionchanged directives from docs 2023-02-08 14:25:09 +00:00
4the4ryushin
529d2feb49 Add docs example for how to configure API renderer_classes
- Update docs/advanced_topics/api/v2/configuration.md
- Fixes #6066
- Fix up spelling of customise (UK English not US)
2023-01-19 20:43:45 +10:00
Sævar Öfjörð Magnússon
629b8e7a55 Add ability to easily use Form Page fields in API
Improve documentation. Adding information about how to retrieve form fields from the API.
Include the API fields on the form field model
2022-11-18 06:58:16 +10:00
LB Johnston
2e8709e0d6 Documentation - update dead/redirected links 2022-10-11 20:44:08 +10:00
Haydn Greatnews
02b2b7c9f2 Fix some casing code in examples in API configuration docs 2022-10-01 17:56:08 +10:00
Storm Heg
6a8ce3161e Fix code style of example in Wagtail API docs
Example code should be compliant with PEP-8.
2022-09-19 21:49:01 +10:00
Christophe Bastin
5dad39fb57 docs: APIField naming (#9173) 2022-09-09 13:47:46 +01:00
Dolidodzik
b131b4813e replace latin abbreviations with english phrases & updated docs guidelines
- added sub-section to language part of general_guidelines.md
- fixes #8860
2022-07-20 16:11:38 +10:00
LB Johnston
cda437804e fix up markdown docs conversion issues
- introduced in #8759 & #8569
2022-06-30 16:36:37 +10:00
LB Johnston
e140c41a89 documentation - markdown formatting
- apply general fixes to existing markdown documentation
- various cases of rst syntax still used
- update some links to be the new format
- clean up line breaks (prettier)
2022-06-25 22:44:42 +10:00
Karl Hobley
996866fc06 Changelog/release note for #8686 2022-06-16 10:10:00 +01:00
Sævar Öfjörð Magnússon
e660326075
Adding multi site support to the pages API. (#8686) 2022-06-16 09:33:47 +01:00
Thiago Costa de Souza
7e73349dc1 documentation - migrate api section to markdown 2022-05-25 21:01:38 +10:00
Paarth Agarwal
da78e0f449 added full_url field for image rendition field api
- resolves #7558
2022-04-20 07:08:24 +10:00
Dmitrii Faiazov
b314f28f37
Add alias_of field into pages API 2021-12-02 13:36:55 +00:00
JS
40e6e1c803 Docs - Update API configuration example
Code correction - date format was incorrect.
2021-11-30 07:58:13 +10:00
Naomi I. Morduch Toubman
99f05d67cb
Change master to main (in more places) (#7358)
* Update references to branches now named `main`

* Change unnecessary use of `master`

* Change link to be to specific ES docs version

Old release notes should link to contemporaneous docs when possible
2021-07-21 14:09:31 -04:00
Karl Hobley
06be13fda0 Changelog / release note for #7077 2021-04-22 17:29:24 +01:00
Jaap Roes
aafd32b66f
Fix #7007: Add ancestor_of API filter (#7077)
* Fix #7007: Add ancestor_of API filter

* Alter descendant_of_with_type test to find at least one page
2021-04-22 17:23:26 +01: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
Karl Hobley
82dafc7ef8 Add docs for new i18n API filters (#6452) 2020-10-16 13:57:37 +01:00
Storm Heg
4076b9ef5e Replace calls to django.conf.urls.url with django.urls.path or django.urls.re_path 2020-07-06 13:15:37 +01:00
Liam Mullens
52cb7ab77b Update ImageRendition field to return Image alt text
* Update ImageRendtion to use default_alt_text property of Image
* Update example in documentation
* Add a test for ImageRenditionField
* Resolves #5816
2020-05-08 11:22:49 +10:00
Karl Hobley
36d440d2dd Rename endpoints modules to views 2019-11-28 09:00:56 +00:00
Karl Hobley
16d5b5c99e Rename Endpoints to ViewSets
For consistency with Django REST Framework
2019-11-28 09:00:35 +00:00
Martey Dodoo
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
Dawn Wages
1b2dadc429 Update configuration.rst (#5576) 2019-09-23 12:06:16 +01:00
Michael Bunsen
b06cb6a6eb
ImageRenditionField returns a relative URL
The example in the docs shows an absolute URL with the site's hostname, but the ImageRenditionField returns a relative URL. 

Relevant source here: https://github.com/wagtail/wagtail/blob/master/wagtail/images/api/fields.py
2019-05-17 16:44:32 -07:00
Evan Winter
5a34090b4b Fix typo in api/v2/usage.rst
first_publised_at --> first_published_at
2019-03-06 01:19:07 +00:00
Michael Harrison
8ef0edb371 Add file download url to Imagesv2 API endpoint 2018-09-06 17:12:02 +01:00
LB
740bbb6c39 fix typos 2018-06-10 12:45:48 +10:00
LB
8d2ee74be0 add reference anchors 2018-06-10 12:45:48 +10:00
Alex Gleason
1c7e90c3ee Change wagtailimages.Image on_delete CASCADE to SET_NULL in docs 2018-05-18 14:51:50 +01:00
Karl Hobley
17f7f70170 Added "find" API view and ability to find pages by HTML path
This implements a new "find" view for all endpoints which can be used
for finding an individual object based on the URL parameters passed to
it.

If an object is found, the view will return a ``302`` redirect to detail
page of that object. If not, the view will return a ``404`` response.

For the pages endpoint, I've added a ``html_path`` parameter to this
view, this allows finding a page by its path on the site.

For example a GET request to ``/api/v2/pages/find/?html_path=/`` will
always generate a 302 response to the detail view of the homepage. This
uses Wagtail's internal routing mechanism so routable pages are
supported as well.

Fixes #4154
2018-04-13 12:08:19 +01:00
Karl Hobley
a9b4b09152 Fix spelling mistakes in documentation 2018-04-05 12:13:05 +01:00
LB
70eb2b6ae3 add on_delete argument to ParentalKey & ForeignKey 2017-12-15 10:33:09 +00:00
Karl Hobley
bf0f3e02ba Rename wagtail.wagtailimages to wagtail.images
Conflicts:
	docs/advanced_topics/api/v2/configuration.rst
	docs/advanced_topics/jinja2.rst
	docs/advanced_topics/settings.rst
	docs/getting_started/integrating_into_django.rst
	docs/getting_started/tutorial.rst
	docs/topics/pages.rst
	docs/topics/streamfield.rst
	gulpfile.js/config.js
	tox.ini
	wagtail/admin/tests/test_compare.py
	wagtail/admin/tests/test_edit_handlers.py
	wagtail/api/v2/signal_handlers.py
	wagtail/contrib/wagtailstyleguide/views.py
	wagtail/core/tests/test_streamfield.py
	wagtail/documents/tests/test_models.py
	wagtail/images/models.py
	wagtail/images/permissions.py
	wagtail/images/tests/test_admin_views.py
	wagtail/images/tests/test_image_operations.py
	wagtail/images/tests/test_models.py
	wagtail/images/tests/test_signal_handlers.py
	wagtail/images/views/chooser.py
	wagtail/images/views/images.py
	wagtail/images/views/multiple.py
	wagtail/images/wagtail_hooks.py
	wagtail/images/widgets.py
	wagtail/project_template/project_name/settings/base.py
	wagtail/tests/demosite/models.py
	wagtail/tests/non_root_urls.py
	wagtail/tests/settings.py
	wagtail/tests/testapp/migrations/0001_initial.py
	wagtail/tests/testapp/migrations/0008_inlinestreampage_inlinestreampagesection.py
	wagtail/tests/testapp/migrations/0009_defaultstreampage.py
	wagtail/tests/urls.py
2017-11-26 22:43:47 +00:00
Karl Hobley
78b1372cd4 Rename wagtail.wagtaildocs to wagtail.documents
Conflicts:
	docs/advanced_topics/i18n/index.rst
	docs/advanced_topics/settings.rst
	docs/getting_started/integrating_into_django.rst
	gulpfile.js/config.js
	wagtail/admin/tests/test_collections_views.py
	wagtail/api/v2/signal_handlers.py
	wagtail/contrib/wagtailstyleguide/views.py
	wagtail/core/tests/test_collection_permission_policies.py
	wagtail/documents/permissions.py
	wagtail/documents/tests/test_admin_views.py
	wagtail/documents/tests/test_collection_privacy.py
	wagtail/documents/tests/test_models.py
	wagtail/documents/views/chooser.py
	wagtail/documents/views/documents.py
	wagtail/documents/views/serve.py
	wagtail/documents/wagtail_hooks.py
	wagtail/documents/widgets.py
	wagtail/project_template/project_name/urls.py
	wagtail/tests/demosite/models.py
	wagtail/tests/non_root_urls.py
	wagtail/tests/settings.py
	wagtail/tests/testapp/models.py
	wagtail/tests/urls.py
2017-11-26 22:43:47 +00:00
Martin Sandström
345b527ca2 Fix syntax error in ImageRenditionField example 2017-11-12 18:07:38 +00:00
Matt Westcott
aebb69a2ba Remove dead links to API v1 docs 2017-11-03 17:03:57 +00:00
Karl Hobley
fa302c0853 Remove wagtail.contrib.wagtailapi 2017-10-25 16:49:17 +01:00
Matt Westcott
b0aedf02dc Remove old versionadded annotations from the docs 2017-08-22 14:08:44 +01:00
Joe Cronyn
d56f1069ef Updating to allow no limit max 2017-08-22 12:09:05 +01:00
Matt Westcott
ca8503846e Fix link to RFC 8 2017-08-16 10:19:16 +01:00
Karl Hobley
fd9db9335a Docs edits 2017-04-06 15:27:34 +01:00