Commit Graph

558 Commits

Author SHA1 Message Date
Victor Moura 1628b35b58 Fixed #31385 -- Improved wording in tutorial 1. 2020-03-24 06:30:34 +01:00
Mariusz Felisiak 5da627a58f
Updated migrations example in tutorial 2.
Follow up to a97845a823.
2020-03-10 08:53:28 +01:00
Mariusz Felisiak 30ca66eadd
Added missing backticks in various docs. 2020-03-06 11:52:49 +01:00
Jon Dufresne 32166a9f7c
Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
Adam Johnson 26be53dd89 Added note about incomplete HTML in tutorial 3. 2020-01-17 15:28:31 +01:00
Anael Mobilia a5a28de89d Added apps.py to project from tutorials in reusable apps docs. 2020-01-16 14:51:27 +01:00
Adam Johnson 2ea3fb3e63 Removed "Don't do that" from docs and error messages.
It's slightly aggressive and doesn't explain itself.
2020-01-06 13:50:43 +01:00
Gabriel Augendre 307c63f9a7 Fixed #30780 -- Improved visibility of Getting Help FAQ in tutorials. 2019-12-31 08:54:26 +01:00
Jon Dufresne 5e00bd1f77 Removed unnecessary code-block directives in various docs. 2019-12-23 14:47:13 +01:00
Mariusz Felisiak 3930ec1bf2
Fixed #31062 -- Doc'd asgi.py in tutorials and project templates. 2019-12-05 08:38:39 +01:00
Fredrik c3ee42d663 Refs #20935 -- Removed inappropriate crosslink to docs search results page.
The link to the search page does not work in the Epub, since there is no such thing. In the online docs, the link to the search page displays a “No search query given” error, since its purpose is to display results from the search bar. Alone, without a query, it's just empty.
2019-12-04 11:36:40 +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
Jon Dufresne 89368ab6e3 Fixed #30944 -- Changed reusable apps docs to use a declarative config. 2019-11-05 14:58:09 +01:00
Ad Timmering dee687e93a Fixed #30816 -- Doc'd how to create projects with a local copy of Django. 2019-10-15 12:38:40 +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
Katie McLaughlin 44077985f5 Fixed #30775 -- Added admonition about missing imports to "Running tests" section in tutorial 5. 2019-09-16 09:40:44 +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
Min ho Kim 3c6a4fdb6d Changed example git clone URLs to use HTTPS. 2019-09-04 08:11:22 +02:00
bcye ac34fccdb9 Fixed broken links to Dive Into Python 3 book. 2019-08-19 07:03:43 +02:00
Frank Wiles c1b94e32fb Fixed explanation of how to automatically create tables in database. 2019-07-15 11:04:30 +02:00
Mariusz Felisiak b6c4766f53
Refs #29548 -- Updated docs for MariaDB support. 2019-05-27 19:59:49 +02:00
Jon Dufresne 8d76443aba Fixed #30399 -- Changed django.utils.html.escape()/urlize() to use html.escape()/unescape(). 2019-04-25 15:09:07 +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
gnl 9f1d78f857
Corrected wording in docs/intro/overview.txt. 2019-04-14 09:34:57 +02:00
Abhishek Bera ca67f39afa Fixed #30265 -- Fixed a tutorial number in Reusable App tutorial. 2019-03-29 21:53:03 -04:00
Tim Graham a68c029e22
Used extlinks for Django's source code. 2019-03-28 20:32:17 -04:00
Tim Graham 8f1cc7e9e6 Fixed #30277 -- Fixed broken links to packaging.python.org. 2019-03-21 10:07:27 -04:00
Matthias Kestenholz c41e6c4eb8 Fixed #30208 -- Fixed login header height and alignment in the largest breakpoint. 2019-02-25 14:39:50 -05:00
Dan Davis 2bd8df243a Fixed #30184 -- Removed ellipsis characters from shell output strings.
Partially reverted 50b8493581 (refs #29654)
to avoid a crash when the user shell doesn't support non-ASCII characters.
2019-02-13 13:59:44 -05:00
Mariusz Felisiak 25829197bb
Removed extra characters in docs header underlines. 2019-02-08 21:38:30 +01:00
Tim Graham 7e6b214ed3 Fixed #30116 -- Dropped support for Python 3.5. 2019-01-30 10:19:48 -05:00
David Beitey 885cb0d390 Fixed "lets" mistakes in docs. 2019-01-14 20:32:19 -05:00
François Freitag 9b15ff08ba Used auto-numbered lists in documentation. 2018-11-15 13:54:28 -05:00
mentix02 413583e2e2 Fixed #29933 -- Fixed typo in docs/intro/contributing.txt. 2018-11-08 16:38:43 -05:00
Tim Graham d8f83531c2
Fixed #22390 -- Doc'd possible server restart required in tutorial 6. 2018-10-31 20:50:10 -04:00
Jon Dufresne 136a900ef9 Refs #29877 -- Made diveinto.org URLs HTTPS. 2018-10-23 15:03:00 +02:00
za b0d716cbff Fixed #29877 -- Replaced diveintopython3.net with diveinto.org/python3/. 2018-10-23 11:55:18 +02:00
Çağıl 38f3de86bd Added a paragraph in docs/intro/contributing.txt. 2018-10-16 16:10:44 -04:00
Adam Johnson 18e4ade79e Fixed #28034 -- Updated the contributing tutorial to use an imaginary ticket. 2018-10-03 14:34:25 -04:00
Thomas Grainger c99d379f53 Updated contributing tutorial's virtual environment instructions. 2018-09-19 14:37:44 -04:00
Curtis Maloney c49ea6f591 Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
Adam Johnson f8ff529ee3 Fixed #29729 -- Updated contributing tutorial to run tests on master. 2018-09-10 10:47:42 -04:00
Claude Paroz 50b8493581 Refs #29654 -- Replaced three dots with ellipsis character in output strings. 2018-08-22 09:13:58 -04:00
luz.paz 97e637a87f Fixed typos in comments and docs. 2018-08-01 16:09:22 -04:00
Tim Graham b4fa94aed8 Removed code terms from docs/spelling_wordlist. 2018-07-31 12:22:28 -04:00
Daniel Roseman 40ff93310f Added help for common 404 error in tutorial 1. 2018-05-21 12:53:40 -04:00
Mariusz Felisiak 35319bf12c
Alphabetized imports in various docs.
Follow-up of d97cce3409 and 7d3fe36c62.
2018-05-12 19:37:42 +02:00
Burhanuddin Baharuddin c2598a6f4d Clarified wording in tutorial text. 2018-04-19 11:09:38 +02:00
Brett Cannon 64b74804c5 Fixed #29334 -- Updated pypi.python.org URLs to pypi.org. 2018-04-17 20:24:27 -04:00
Melissa Lewis d97cce3409 isorted import statements in tutorial example 2018-03-22 08:53:56 +01:00
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి) c4fa0143f7 Removed "Remove any old versions of Django" install instructions.
They are obsolete given the prevalence of pip.
2018-02-26 08:58:56 -05:00
Roger Erens a94fd8a8d9 Used a CSS positioning in tutorial 6 that doesn't differ across browsers.
Otherwise in Firefox, the <html> and <body> elements take just as much height
is needed for the content and so the image doesn't appear at the bottom of the
window.
2018-02-21 12:07:24 -05:00
Tim Graham 4775dcb521 Renamed the "Supported versions" label. 2018-01-31 10:17:06 -05:00
Christoph Zwerschke d4bbd3f418 Corrected an explanation in tutorial 5. 2018-01-29 12:48:37 -05:00
Devin Mork 2e625095fe Made instructions for shell launch in tutorial 5 more explicit. 2018-01-23 18:10:59 -05:00
Jon Dufresne ff05de760c Fixed #29038 -- Removed closing slash from HTML void tags. 2018-01-21 02:09:10 -05:00
Ramiro Morales 37c17846ad Fixed #28343 -- Add an OS chooser for docs command line examples. 2018-01-20 12:38:48 -05:00
Tim Graham afd50a3019 Replaced "trunk" with "master branch" in docs. 2018-01-18 16:30:38 -05:00
Tim Graham a8e492bc81
Removed note in tutorial about bypassing manage.py.
This isn't relevant for beginners.
2018-01-11 19:05:59 -05:00
Claude Paroz 23b21db31b Fixed #28594 -- Removed Jython docs and specific code
Thanks Andrey Martyanov for the reporti, and Tim Graham for the review.
2017-12-23 10:26:32 +01:00
Daniel Hepper 4dcd7723d5 Fixed #28938 -- Corrected Python compatibility in the tutorial. 2017-12-18 08:51:36 -10:00
Claude Paroz f2ec896912 Removed 'development' word in contributing docs 2017-12-05 18:42:37 +01:00
Tim Graham cfff2af02b Fixed #27857 -- Dropped support for Python 3.4. 2017-09-25 17:11:03 -04:00
Sjoerd Job Postmus df41b5a05d Fixed #28593 -- Added a simplified URL routing syntax per DEP 0201.
Thanks Aymeric Augustin for shepherding the DEP and patch review.
Thanks Marten Kenbeek and Tim Graham for contributing to the code.
Thanks Tom Christie, Shai Berger, and Tim Graham for the docs.
2017-09-20 18:04:42 -04:00
Tim Graham 9075805570 Refs #23276 -- Fixed explanation of how calling views works.
"Importing the view" is no longer applicable after
a9fd740d22.
2017-08-31 11:57:46 -04:00
Timothy Allen 5fe9b7b40a Fixed #28457 -- Updated the design of the 'Congrats' page for new Django projects.
Developed by Timothy Allen and Chad Whitman of The Wharton School with
shepherding from Aymeric Augustin and Collin Anderson.
2017-08-07 10:33:55 -04:00
Tim Graham 259875535b Removed unneeded right quotes in docs to fix spelling errors.
A regression in pyenchant caused a problem:
https://github.com/rfk/pyenchant/issues/93
2017-07-18 08:24:49 -04:00
marton bognar 8274160520 Fixed #28361 -- Fixed possible time-related failure in was_published_recently() tutorial test.
Regression in 268a646353.
2017-07-06 18:23:49 -04:00
Mariusz Felisiak 081e787160 Refs #23919 -- Stopped inheriting from object to define new style classes.
Tests and docs complement to cecc079168.
2017-06-26 10:30:31 -04:00
Collin Anderson 1a49b89470 Fixed #27953 -- Added instance's pk to Model.__str__(). 2017-06-09 13:42:53 -04:00
Tim Graham 23825b2494 Simplified tutorial's test names and docstrings. 2017-06-07 09:47:15 -04:00
Tim Graham 268a646353 Updated was_published_recently() tutorial test to check boundary condition. 2017-06-06 12:16:03 -04:00
Eric Theise 1b5b3710f1 Added some shell output in tutorial 2. 2017-05-25 13:43:21 -04:00
Claude Paroz 01f658644a Updated various links in docs to avoid redirects
Thanks Tim Graham and Mariusz Felisiak for review and completion.
2017-05-22 19:28:44 +02:00
Michiel Beijen 48028c6f9a Pointed Dive into Python links to python3 site
The old site handles python2, and is thus no longer relevant for Django.
Also I pointed the search path links to the proper sections.
2017-05-20 15:32:35 +02:00
Michiel Beijen 5e8625ba64 Renamed "Mac OS X" to "macOS" in docs. 2017-04-24 20:16:09 -04:00
Tim Graham 45d65fc3f2 Fixed #28069 -- Moved setup_test_environment() warning in tutorial 5.
Updated for 17e661641d.
2017-04-12 08:17:46 -04:00
Timothy Allen 7d20a7d88a Used "0" ip shortcut for runserver example. 2017-02-21 19:13:00 -05:00
Tim Graham 5729272509 Clarified that creating a pull request for the tutorial isn't necessary. 2017-02-16 11:33:07 -05:00
Tim Graham ad36e5480d Explained the shell's $ prefix in tutorial 1.
Thanks Luke Sneeringer for the suggestion.
2017-02-09 09:33:42 -05:00
Subhrajyoti Sen f5bf11c72b Fixed #26708 -- Updated the contributing tutorial to use a GitHub workflow. 2017-01-28 11:45:04 -05:00
Tim Graham 9d27478958 Refs #23919 -- Removed docs references to long integers. 2017-01-19 13:19:26 -05:00
Tim Graham f6acd1d271 Refs #23919 -- Removed Python 2 notes in docs. 2017-01-18 11:51:29 -05:00
Claude Paroz f3c43ad1fd Refs #23919 -- Removed python_2_unicode_compatible decorator usage 2017-01-18 13:44:34 +01:00
Tim Graham 991cd69621 Fixed #27711 -- Demoted "Installing a distribution-specific package" in install intro. 2017-01-10 09:29:23 -05:00
Adam Chainz 5eff8a7783 Fixed #25415 -- Made DiscoverRunner run system checks. 2016-12-29 12:33:24 -05:00
Daniel Musketa 66505b72c5 Updated doc links to virtualenv website. 2016-11-22 08:36:41 -05:00
Tim Graham b741fe397a Updated "fork Django on GitHub" link. 2016-11-04 05:47:49 +01:00
mark-summerfield 4584bc3a1e Described PostgreSQL as more scalable than SQLite. 2016-10-27 09:14:04 -04:00
Tim Graham d84ffcc22b Updated "running the tests" to use 'pip install -e'. 2016-10-27 08:18:56 -04:00
Ankur Gupta 40d5011471 Fixed #27174 -- Explained where PollsConfig comes from in tutorial 2. 2016-09-07 14:12:53 -04:00
Tim Graham cf2cd4053f Fixed #27104 -- Corrected shell example in tutorial 5. 2016-08-24 09:11:50 -04:00
Tim Graham b40d24960c Fixed #27115 -- Corrected a screenshot in the tutorial. 2016-08-24 08:59:49 -04:00
Tim Graham 44c306218f Fixed #27085 -- Corrected a screenshot in the tutorial. 2016-08-19 18:04:57 -04:00
Vincent Zhang 7b08e01c13 Refs #26747 -- Corrected a method name in tutorial05. 2016-08-19 11:10:28 -04:00
an0o0nym 2b759c94c5 Fixed #26952 -- Added tips for installing test suite dependencies. 2016-08-09 18:37:09 -04:00
Tim Graham cd58f13fb6 Removed obsolete note about Sphinx version required for building docs. 2016-08-09 18:11:26 -04:00
Daniel Rice 08c723fbae Reworded a sentence in tutorial 7. 2016-07-14 07:50:29 -04:00
Tim Graham 415ae960bb Fixed capitalization of "URL pattern". 2016-07-06 15:31:12 -04:00