1
0
mirror of https://github.com/django/django.git synced 2024-12-29 12:36:08 +00:00
Commit Graph

714 Commits

Author SHA1 Message Date
Mariusz Felisiak
f331eba6d5
Refs #32880 -- Made remaining titles consistent in how-to documents.
Follow up to 22fbebc744.
2021-07-29 19:11:42 +02:00
David Smith
1024b5e74a Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
David Smith
acde917456
Refs #32956 -- Lowercased "internet" and "email" where appropriate. 2021-07-28 12:56:56 +02:00
David Smith
1cba320786
Refs #32956 -- Changed "afterwards" to "afterward" in docs and comments.
This also removes unnecessary comments with the previous spelling.

AP Stylebook has a short entry to advise the preferred spelling for
"en-us". "Afterwards" is preferred in British English.
2021-07-27 10:41:51 +02:00
Daniele Procida
22fbebc744
Refs #32880 -- Made some titles consistent in how-to documents.
This retitles documents for consistency, since some already (correctly)
begin "How to...".
2021-07-13 09:25:37 +02:00
Daniele Procida
013a1824d3 Refs #32880 -- Created a new logging how-to document.
Moved how-to material from topic document into a new document, and
added new material. Introduced minor improvements to logging
reference document.
2021-07-12 09:04:25 +02:00
Nick Pope
c156e36955 Refs #32720 -- Updated various links in docs to avoid redirects and use HTTPS. 2021-05-17 09:46:09 +02:00
David Smith
0456d3e427
Fixed #26721 -- Doc'd setting UTF-8 on Windows. 2021-05-12 20:46:01 +02:00
Carlton Gibson
4f128fcf5d
Refs #32694 -- Clarified when colorama requirement is needed in Windows how-to. 2021-04-29 11:26:38 +02:00
Abhyudai
4a77aeb1f8
Fixed #32667 -- Added link to labeling checks in BaseCommand.requires_system_checks docs.
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2021-04-21 16:40:04 +02:00
William Schwartz
7248afe12f Refs #32105 -- Moved ExceptionReporter template paths to properties.
Refs #32316.
2021-03-31 08:41:57 +02:00
Markus Holtermann
7cc6899d41 Updated links to DEPs. 2021-02-25 17:22:07 +01:00
Markus Holtermann
50a5f8840f Refs #32394 -- Changed STATIC_URL/MEDIA_URL to relative paths in tests and docs where appropriate. 2021-02-06 13:41:35 +01:00
Amankumar Singh
51637222b6
Fixed #32419 -- Clarified URLconf in example of serving media files. 2021-02-05 15:33:53 +01:00
Mariusz Felisiak
73ffc73b68 Corrected versionadded annotations. 2021-01-19 11:52:47 +01:00
Mariusz Felisiak
b7dd89ed53 Removed versionadded/changed annotations for 3.1. 2021-01-14 17:50:04 +01:00
MinchinWeb
f1585c54d0
Fixed #31216 -- Added support for colorama terminal colors on Windows.
Modern setups on Windows support terminal colors.
The colorama library may also be used, as an
alternative to the ANSICON library.
2020-11-11 14:27:10 +01:00
Nikita Sobolev
42f3fafdfa
Updated {% static %} tag examples in docs to use single quotes where appropriate. 2020-11-02 10:34:24 +01:00
Aarni Koskela
68e33b347d Fixed #32105 -- Added template paths as ExceptionReporter class attributes.
This allows replacement of the debugging templates without having to
copy-paste the `get_traceback_html` and `get_traceback_text` functions
into a subclass.

Thanks to Nick Pope for review.
2020-10-15 13:56:15 +02:00
Tom Carrick
dcb69043d0 Fixed #32002 -- Added headers parameter to HttpResponse and subclasses. 2020-10-07 09:19:57 +02:00
Thomas Grainger
c1442e1192
Updated ASGI uvicorn deployment docs. 2020-09-29 10:55:06 +02:00
Tom Carrick
bcc2befd0e Fixed #31789 -- Added a new headers interface to HttpResponse. 2020-09-14 08:41:59 +02:00
Mariusz Felisiak
e39e727ded
Fixed #31912 -- Removed strict=True in Path.resolve() in project template and CommonPasswordValidator.
This caused permission errors when user didn't have permissions to
all intermediate directories in a Django installation path.

Thanks tytusd and leonyxz for reports.

Regression in edeec1247e and
26554cf5d1.
2020-08-28 05:57:36 +02:00
Phil Jones
1bd1264f2e
Added Hypercorn to ASGI deployment guide. 2020-08-05 12:14:06 +02:00
David Smith
2c2f4b3799 Fixed #29336 -- Doc'd circular template inheritance 2020-08-05 11:36:14 +02:00
Ramiro Morales
52a0a03671 Corrected custom model fields how-to.
get_prep_value() method is complementary of from_db_value().

Follow up to e9103402c0.
2020-07-10 11:11:40 +02:00
David Smith
dbdc192ca3 Preferred usage of among/while to amongst/whilst. 2020-06-03 21:02:48 +02:00
David Smith
25352dc019
Updated How to install Django on Windows guide. 2020-06-03 16:28:10 +02:00
Jon Dufresne
8ce570f2f2
Fixed #31643 -- Changed virtualenv doc references to Python 3 venv. 2020-06-02 11:45:44 +02:00
René Fleschenberg
578b3046e3 Reverted "Refs #23919 -- Removed obsolete __init__.py files in management command directories."
This reverts commit ccc25bfe4f.

https://groups.google.com/d/topic/django-developers/GVHMH2ciAnk/discussion
2020-06-01 10:55:41 +02:00
Jon Dufresne
494ba27b5f
Changed some doc links to use intersphinx. 2020-05-29 21:09:57 +02:00
David Smith
922ff51f5a Fixed #31628 -- Updated Windows install guide to recommend venv. 2020-05-27 11:18:23 +02:00
Claude Paroz
cfa0c0e252
Removed instructions for unsupported Apache versions. 2020-05-25 08:56:50 +02:00
Hasan Ramezani
c60524c658 Fixed #31546 -- Allowed specifying list of tags in Command.requires_system_checks. 2020-05-21 12:34:54 +02:00
Nick Pope
fbdb032de2 Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +02:00
Nick Pope
a9337b4add Used :pep: role in various docs. 2020-05-13 09:14:04 +02:00
Mariusz Felisiak
4c5236ef93 Removed versionadded/changed annotations for 3.0. 2020-05-13 09:07:51 +02:00
Adam Johnson
d17b380653 Refs #30573 -- Rephrased "Of Course" and "Obvious(ly)" in documentation and comments. 2020-05-04 12:10:47 +02:00
David Smith
bb13711451 Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02:00
Adam Johnson
8e8c3f964e Refs #29501 -- Allowed customizing exit status for management commands. 2020-04-14 13:22:47 +02:00
Adam Johnson
1cdfe8d912 Prevented (and corrected) single backtick usage in docs. 2020-04-01 14:55:11 +02:00
Adam Johnson
66b06822d0
Improved sessions notes in deployment checklist.
- Added note to clear old sessions when using database-backend.
- Made note to consider the cache backend more generic.
2020-03-25 12:04:52 +01:00
Mariusz Felisiak
2117b7c12e
Updated settings example in overriding templates docs.
Follow up to ba4389a36b.
2020-03-21 20:02:57 +01:00
Adam Johnson
a9ee6872bd Clarified SeparateDatabaseAndState docs and added example of changing ManyToManyField.
Co-Authored-By: Mariusz Felisiak <felisiak.mariusz@gmail.com>
Co-Authored-By: Carlton Gibson <carlton.gibson@noumenal.es>
Co-Authored-By: René Fleschenberg <rene@fleschenberg.net>
2020-03-10 11:07:36 +01:00
Mariusz Felisiak
30ca66eadd
Added missing backticks in various docs. 2020-03-06 11:52:49 +01:00
Nick Pope
335c9c94ac Simplified imports from django.db and django.contrib.gis.db. 2020-02-04 13:20:06 +01:00
Abhijeet
a45c8d7ad0
Fixed #31126 -- Doc'd STATICFILES_DIRS namespacing in static files how-to. 2020-01-29 10:34:34 +01:00
Adam Johnson
e4bc4f26b2 Made examples concrete in upgrade documentation. 2020-01-21 13:02:14 +01:00
Takayuki Hirayama
73563183c2 Fixed #31171 -- Fixed wording in auto-escaping section of custom template tags docs. 2020-01-17 09:20:44 +01:00
Pavel Lysak
13e4abf83e Fixed #30752 -- Allowed using ExceptionReporter subclasses in error reports. 2020-01-16 15:25:49 +01:00
Carlton Gibson
e2d9d66a22 Fixed #23004 -- Added request.META filtering to SafeExceptionReporterFilter.
Co-authored-by: Ryan Castner <castner.rr@gmail.com>
2020-01-10 11:35:41 +01:00
Carlton Gibson
581ba5a948 Refs #23004 -- Allowed exception reporter filters to customize settings filtering.
Thanks to Tim Graham for the original implementation idea.

Co-authored-by: Daniel Maxson <dmaxson@ccpgames.com>
2020-01-10 11:21:23 +01:00
Katie McLaughlin
abeb4599af Refs #30767 -- Improved deployment documentation. 2019-12-20 10:42:56 +01:00
Nick Pope
d8b6a76bc7 Refs #28954 -- Remove remaining Jython documentation.
There is still no further progress on Jython 3 since support for Jython
was stripped in Django 2.0. The developers experimenting with Jython 3
have stated that they would need to start from scratch, so it doesn't
look as though it will materialize for years to come.

Python 2 and Django 1.11, the last version to support Python 2.7, will
both be end-of-life before Django 3.1 is released. We should no longer
instruct users to use an unsupported version of Django.
2019-12-19 16:42:12 +01:00
Adam Johnson
ef3baf966d Updated Pytest example in upgrade documentation.
Pytest changed their recommended entrypoint to 'pytest' in version 3.0.0 in 2016 : https://docs.pytest.org/en/latest/changelog.html#id1009. Also link the name since this is the only reference in the Django documentation at current.
2019-12-18 10:42:41 +01:00
Fredrik
98188cb33d Refs #20935 -- Removed duplicate ToC references.
These sections are being referred to already from other locations. Having multiple references to the same location from the ToC is ambiguous, and causes errors in the EPUB build.
2019-12-04 11:36:40 +01:00
Hasan Ramezani
33eecfa740 Fixed #30999 -- Fixed typo in docs/howto/custom-template-tags.txt. 2019-11-19 10:08:32 +01:00
Jon Dufresne
26554cf5d1 Fixed #29983 -- Replaced os.path() with pathlib.Path in project template and docs.
Thanks Curtis Maloney for the original patch.
2019-11-07 11:11:27 +01:00
Hasan Ramezani
05c3ef26a2 Fixed #30906 -- Fixed an example of using the template system to generate CSV. 2019-10-25 08:11:11 +02:00
Carlton Gibson
94eae4e563 Fixed #30858 -- Clarified that AdminEmailHandler processes all 5xx responses. 2019-10-09 10:13:11 +02:00
Min ho Kim
103a6f4307 Fixed some typos in comments and docs.
Thanks to Mads Jenson for review.
2019-10-02 15:50:46 +02:00
Mariusz Felisiak
416c584cab Removed versionadded/changed annotations for 2.2. 2019-09-10 12:01:00 +02:00
Katie McLaughlin
fee75d2aed Fixed #30767 -- Improved references to deployment documentation.
* Increased tocdepth to expose more complexity of topics.
* Ensured deployment checklist is linked on main doc page.
2019-09-09 10:02:33 +02:00
Tobias Kunze
4a954cfd11 Fixed #30573 -- Rephrased documentation to avoid words that minimise the involved difficulty.
This patch does not remove all occurrences of the words in question.
Rather, I went through all of the occurrences of the words listed
below, and judged if they a) suggested the reader had some kind of
knowledge/experience, and b) if they added anything of value (including
tone of voice, etc). I left most of the words alone. I looked at the
following words:

- simply/simple
- easy/easier/easiest
- obvious
- just
- merely
- straightforward
- ridiculous

Thanks to Carlton Gibson for guidance on how to approach this issue, and
to Tim Bell for providing the idea. But the enormous lion's share of
thanks go to Adam Johnson for his patient and helpful review.
2019-09-06 13:27:46 +02:00
Mariusz Felisiak
6201141b2c Refs #30736 -- Added missing versionadded annotations for Storage.get_alternative_name().
Thanks Simon Charette for the report.
2019-08-31 07:19:19 +02:00
yukihira1992
0545781764 Fixed #30736 -- Added Storage.get_alternative_name() to allow customization. 2019-08-30 11:32:19 +02:00
Claude Paroz
7203efb799 Fixed #30694 -- Documented FileResponse does not seek its file source. 2019-08-17 09:20:36 +02:00
Frank Wiles
fa65b90a96 Updated WSGI servers ordering according to the more commonly used. 2019-07-16 14:43:59 +02:00
Andrew Godwin
a415ce70be Fixed #30451 -- Added ASGI handler and coroutine-safety.
This adds an ASGI handler, asgi.py file for the default project layout,
a few async utilities and adds async-safety to many parts of Django.
2019-06-20 12:29:43 +02:00
Hasan Ramezani
a7038adbd0 Fixed typos in signals and custom management commands docs. 2019-06-19 08:40:46 +02:00
Alex Gaynor
f011d9ea56 Fixed datetime string format examples in docs/howto/custom-template-tags.txt. 2019-05-22 06:47:32 +02:00
mentix02
fa422dd78b Changed poll_id to poll_ids in examples of custom management commands. 2019-05-20 10:11:38 +02:00
Jon Dufresne
e86cc14bd3 Changed docs to link to Python's description of iterable. 2019-05-17 17:27:19 +02:00
Daniel Musketa
6fd9c9daa6 Fixed #30365 -- Fixed syntax highlighting in SQL examples.
Sphinx interprets some "%[a-z]" in SQL statements as a
"Literal.String.Interpol" which leads to incorrect highlighting.
2019-04-23 12:37:50 +02:00
Ramiro Morales
25b5eea8cd Fixed #30387 -- Enhanced docs CLI examples in Unit tests and Install Django on Windows.
Follow up to 37c17846ad.
2019-04-23 09:32:55 +02:00
Ramiro Morales
aed89adad5 Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints. 2019-04-18 14:41:15 +02:00
Nick Pope
198a2a9381 Removed unnecessary /static from links to PostgreSQL docs. 2019-03-29 21:49:44 -04:00
David Beitey
9fd90c4088 Clarified deconstruct() in Custom Model Field docs. 2019-03-12 10:12:33 -04:00
Mariusz Felisiak
25829197bb
Removed extra characters in docs header underlines. 2019-02-08 21:38:30 +01:00
Himanshu Lakhara
22aab8662f Fixed #30004 -- Changed default FILE_UPLOAD_PERMISSION to 0o644. 2019-02-08 14:53:15 -05:00
Tim Graham
77d25dbd0f Refs #27753 -- Favored SafeString over SafeText. 2019-02-06 14:12:06 -05:00
Tim Graham
7e6b214ed3 Fixed #30116 -- Dropped support for Python 3.5. 2019-01-30 10:19:48 -05:00
Tim Graham
ec7e179aeb Removed versionadded/changed annotations for 2.1. 2019-01-17 10:50:25 -05:00
CHI Cheng
b7dbd5ff68 Fixed broken links to PyYAML page. 2018-12-27 10:48:37 +01:00
Rodrigo
ad191d9e01 Fixed #29895 -- Doc'd why MySQL's atomic DDL statements don't work for atomic migrations. 2018-12-06 16:03:02 -05:00
François Freitag
9b15ff08ba Used auto-numbered lists in documentation. 2018-11-15 13:54:28 -05:00
Mads Jensen
961f8e9985 Updated some links to https and new locations. 2018-11-10 17:40:50 -05:00
Adam Johnson
cecd656184 Simplified deployment checklist docs on customizing error views. 2018-10-11 09:50:08 -04:00
Jon Dufresne
82f286cf6f Refs #29784 -- Switched to https:// links where available. 2018-09-26 08:48:47 +02:00
Stephen Finucane
25f4302349 Emphasized that TemplatesSetting must be used to override widget templates. 2018-09-11 15:14:53 -04:00
Curtis Maloney
c49ea6f591 Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
priyanshsaxena
83b04d4f88 Fixed #29048 -- Added **extra_context to database function as_vendor() methods. 2018-08-23 11:52:09 -04:00
Carlton Gibson
ef70af77ec Refs #28540 -- Added FILE_UPLOAD_PERMISSIONS to deployment checklist. 2018-08-04 10:39:22 -04:00
Claude Paroz
eac9ab7ebb Removed parser.add_arguments() arguments that match the defaults. 2018-07-02 17:54:57 -04:00
humbertotm
e95008f241 Fixed #29152 -- Allowed passing kwargs to ArgumentParser initialization in management commands. 2018-06-16 15:54:59 -04:00
Dr. Shubham Dipt
44441d673b Corrected typo in outputting-csv.txt. 2018-06-01 12:07:55 +02:00
Srinivas Reddy Thatiparthy
4c35a173e8 Fixed #29423 -- Documented Field.value_from_object(). 2018-05-25 15:10:45 -04:00
Claude Paroz
a177f854c3
Fixed #16470 -- Allowed FileResponse to auto-set some Content headers.
Thanks Simon Charette, Jon Dufresne, and Tim Graham for the reviews.
2018-05-15 18:12:11 +02:00
Claude Paroz
d65b0f72de Fixed #17379 -- Removed management commands deactivation of the locale. 2018-05-13 10:21:53 +02:00
Mariusz Felisiak
35319bf12c
Alphabetized imports in various docs.
Follow-up of d97cce3409 and 7d3fe36c62.
2018-05-12 19:37:42 +02:00