Commit Graph

629 Commits

Author SHA1 Message Date
Nick Pope 4eb5e4ee4f [3.1.x] Used :envvar: role and .. envvar:: directive in various docs.
Backport of fbdb032de2 from master
2020-05-13 09:38:59 +02:00
Nick Pope 15d76dc2ab [3.1.x] Used :pep: role in various docs.
Backport of a9337b4add from master
2020-05-13 09:38:40 +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