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

387 Commits

Author SHA1 Message Date
Jignesh Kotadiya
7b4bd2a82c
Refs #22463 -- Replaced JSHint with ESLint in contributing docs. 2020-04-20 10:53:00 +02:00
Mariusz Felisiak
cc70a0343e
Fixed term warning on Sphinx 3.0.1+.
"term" role became case sensitive in Sphinx 3.0.1.
2020-04-14 09:32:09 +02:00
Adam Johnson
1cdfe8d912 Prevented (and corrected) single backtick usage in docs. 2020-04-01 14:55:11 +02:00
Takuya Noguchi
c25a8c77d7 Fixed #31241 -- Clarified porting translations of the Django docs to docs.djangoproject.com. 2020-02-12 08:41:48 +01:00
Vibhu Agarwal
6f9ecc23f6
Fixed #31226 -- Fixed typo in docs/internals/contributing/writing-code/submitting-patches.txt. 2020-02-03 20:16:06 +01:00
Vibhu Agarwal
1a09708dcb Fixed #31222 -- Fixed typo in docs/internals/contributing/bugs-and-features.txt. 2020-02-03 11:02:58 +01:00
Mariusz Felisiak
0ac8ac8b0d
Refs #25778 -- Updated some links to HTTPS and new locations. 2020-01-29 09:34:37 +01:00
Jon Dufresne
32166a9f7c
Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
Mads Jensen
ea44d86ed4 Added guidelines for assertIs() usage. 2019-12-30 11:25:18 +01:00
Jon Dufresne
5708327c37 Fixed #23433 -- Deprecated django-admin.py entry point in favor of django-admin.
Unify on the entry point created by setuptools entry_points feature.
2019-12-06 12:11:44 +01:00
Hasan Ramezani
b1d39131eb Fixed typo in internals/contributing/writing-documentation.txt. 2019-12-03 20:11:54 +01:00
Baptiste Mispelon
42df1b178b Refs #31029 -- Added note about :rfc: role in writing documentation docs. 2019-11-27 20:52:28 +01:00
Carlton Gibson
36453526d3
Pinned asgiref version. 2019-11-20 14:57:08 +01:00
Stephen Rauch
4b6db766ba Refs #30183 -- Doc'd dropping support for sqlparse < 0.2.2.
Support for sqlparse < 0.2.2 was broken in
782d85b6df because is_whitespace property
was added in sqlparse 0.2.2.
2019-11-06 08:45:43 +01:00
André Ericson
54a7b02112 Fixed #30927 -- Simplified an example of test for the deprecation warning with assertWarnsMessage(). 2019-10-30 13:35:36 +01:00
Mariusz Felisiak
2a54ce72f9 Added tblib to the list of test suite dependencies in documentation. 2019-10-23 15:26:04 +02:00
Mariusz Felisiak
e10ebf43e1
Bumped minimum Pillow version to 6.2.0 in test requirements.
Pillow < 6.2.0 is vulnerable to CVE-2019-16865.
2019-10-23 15:07:06 +02:00
Carlton Gibson
adfd920cc5 Moved "Sign the CLA" to the bottom of New Contributor First Steps.
As discussed on the mailing list, step 1 of First Steps shouldn't be
"Find a printer".

https://groups.google.com/d/topic/django-developers/owOqFmxufgs/discussion
2019-10-15 14:10:35 +02:00
Graham Healy
90abdba086 Fixed #30808 -- Added the Django Forum to contributing index. 2019-10-15 08:32:37 +02:00
Kees Hink
5d9cf79baf Fixed #27086 -- Doc'd fix for test suite hang on macOS. 2019-10-09 15:46:44 +02:00
Carlton Gibson
06e087c3de Added note to check Python version in unit tests troubleshooting section.
At DjangoCon US 2019 sprints, a number of contributors hit problems with an outdated Python.
2019-10-09 15:46:44 +02:00
Carlton Gibson
b39c39e82a Corrected section indentation in unit tests contributor docs. 2019-10-09 15:46:44 +02:00
Katherine Michel
f7eb9fb676 Refs #30010 -- Doc'd running tests with django-docker-box. 2019-10-02 13:43:47 +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
053ff7e9e6 Fixed typo in docs/internals/contributing/writing-documentation.txt. 2019-09-05 14:06:46 +02:00
Carlton Gibson
ed2d411aa8 Refs #30573 -- Noted to avoid "simple" & co. in Writing Style guide.
Co-authored-by: Tobias Kunze <r@rixx.de>
2019-09-05 10:13:31 +02:00
Min ho Kim
3c6a4fdb6d Changed example git clone URLs to use HTTPS. 2019-09-04 08:11:22 +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
e2de49ec2e Fixed #28520 -- Added --start-at/--start-after options to runtests.py. 2019-05-31 07:01:12 +02:00
Johannes Hoppe
8d010f3986 Fixed #30220 -- Added support for headless mode in selenium tests. 2019-05-17 08:14:54 +02:00
Jon Dufresne
97d3321e89 Changed tuple choices to list in docs. 2019-05-15 14:31:42 +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
Ville Skyttä
34a68c2cbe Fixed typo in docs/internals/contributing/committing-code.txt. 2019-04-21 12:47:33 +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
Tim Graham
9caa3e0a29
Doc'd a few contributing guidelines. 2019-03-25 18:26:23 -04:00
Tim Graham
7e6b214ed3 Fixed #30116 -- Dropped support for Python 3.5. 2019-01-30 10:19:48 -05:00
Tom Forbes
c8720e7696 Fixed #27685 -- Added watchman support to the autoreloader.
Removed support for pyinotify (refs #9722).
2019-01-13 20:33:47 -05:00
Mads Jensen
961f8e9985 Updated some links to https and new locations. 2018-11-10 17:40:50 -05:00
Tim Graham
f82be9ebc7
Fixed #29934 -- Added sqlparse as a require dependency. 2018-11-09 19:09:36 -05:00
Mice Pápai
5a2dd5ec53 Fixed typo in docs/internals/contributing/writing-code/coding-style.txt. 2018-11-02 15:59:12 +01:00
Jon Dufresne
82f286cf6f Refs #29784 -- Switched to https:// links where available. 2018-09-26 08:48:47 +02:00
Jon Dufresne
8c3e0eb1c1 Normalized spelling of "lowercase" and "lowercased". 2018-09-25 10:30:18 -04:00
Curtis Maloney
c49ea6f591 Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
Maxime Lorant
31407fa3b3 Removed duplicate words in docs.
.
2018-07-18 11:24:06 -04:00
Morgan Aubert
704443acac Fixed #29363 -- Added SimpleTestCase.assertWarnsMessage(). 2018-05-09 11:40:28 -04:00
PhrydRhys
5d022eae74 Fixed #29369 -- Mentioned the #django-dev IRC channel in contributing index. 2018-04-28 20:33:53 -04:00
Brett Cannon
64b74804c5 Fixed #29334 -- Updated pypi.python.org URLs to pypi.org. 2018-04-17 20:24:27 -04:00
Tim Graham
3428be3cf9 Updated contributing docs for some latest practices. 2018-04-06 20:46:06 -04:00
Tim Graham
73cb62a331 Fixed links to Sphinx docs. 2018-03-30 14:29:23 -04:00
Daniel Chimeno
fbb9358149 Replaced 'python -Wall' with 'python -Wa'. 2018-03-28 13:25:03 -04:00
Roy Zwambag
fe32fe1619 Used console directive in "Writing documentation". 2018-03-07 16:19:22 -05:00
Tim Graham
4775dcb521 Renamed the "Supported versions" label. 2018-01-31 10:17:06 -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
b902878fd6 Doc'd the latest state of the Jenkins pull request builders. 2018-01-17 08:48:53 -05:00
Mariusz Felisiak
7c81b28ebc
Updated various links in docs to use HTTPS. 2018-01-07 14:28:41 +01:00
weijunji
1ef8b30abe Fixed #28929 -- Corrected QUnit examples. 2017-12-18 09:49:00 -10: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
Tim Graham
c68f5d83c0 Fixed #27655 -- Added some guidelines to the coding style docs. 2017-06-12 15:39:09 -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
Mariusz Felisiak
9b2d47bcde Fixed broken link to QUnit docs. 2017-05-03 07:31:59 -04:00
Markus Holtermann
6d7cbe67f0 Removed inappropriate highlighting in committing-code.txt. 2017-04-20 11:32:56 -04:00
Sergey Fedoseev
24d40e7e0c Removed unused links in docs/internals/contributing/triaging-tickets.txt. 2017-03-25 13:05:48 -04:00
Mikkel Munch Mortensen
1e93210f1f Fixed #27963 -- Removed unneeded docstring example in contributing docs. 2017-03-21 10:12:41 -04:00
Tim Graham
3d14cbc867 Removed docs/internals/roles.txt.
It's moved to https://www.djangoproject.com/foundation/teams/.
2017-02-15 09:31:41 +01: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
e27e4c0339 Removed versionadded/changed annotations for 1.10. 2017-01-17 20:52:05 -05:00
Tim Graham
61225ef721 Removed the importance of "core developers" in triaging tickets, etc. 2016-12-21 20:18:13 -05:00
Alix Martineau
0a8c685447 Fixed #27439 -- Documented macOS locale configuration for Django tests. 2016-12-20 12:58:14 -05:00
Tim Graham
b5f0b3478d Fixed #27579 -- Added aliases for Python 3's assertion names in SimpleTestCase. 2016-12-07 17:42:31 -05:00
François Freitag
0783aa7deb Refs #23811 -- Corrected git bisect run example usage. 2016-11-21 06:55:03 -05:00
akki
74ed20b49a Replaced "django" with "Django" in spelling_wordlist. 2016-11-15 17:00:50 -05:00
za
321e94fa41 Refs #27392 -- Removed "Tests that", "Ensures that", etc. from test docstrings. 2016-11-10 21:30:21 -05:00
Tim Graham
b741fe397a Updated "fork Django on GitHub" link. 2016-11-04 05:47:49 +01:00
Tim Graham
414ad25b09 Fixed #27327 -- Simplified time zone handling by requiring pytz. 2016-10-27 08:53:20 -04:00
Tim Graham
d84ffcc22b Updated "running the tests" to use 'pip install -e'. 2016-10-27 08:18:56 -04:00
Julian Andrews
adc93e8599 Fixed #26357 -- Allowed admin popups to work on links added after page load. 2016-10-24 20:17:31 -04:00
Tim Graham
e261337eea Fixed docs typos in lines ending with a dash. 2016-10-06 11:01:20 -04:00
Tim Graham
ddef397b0d Doc'd how to use GitHub's "Squash and merge" button. 2016-09-21 12:13:21 -04:00
an0o0nym
2b759c94c5 Fixed #26952 -- Added tips for installing test suite dependencies. 2016-08-09 18:37:09 -04:00
Adam Zapletal
4f113483d7 Fixed a few grammar issues in working-with-git doc. 2016-08-06 08:11:48 -04:00
Tobias McNulty
09d38746ba Fixed #22446 -- Added tox.ini to automate pull request checks. 2016-07-20 14:06:28 -04:00
Jiang Haiyun
10883b63b7 Fixed typo in docs/internals/contributing/writing-code/coding-style.txt 2016-07-13 10:15:39 -04:00
shaunagm
44c7e5d374 Fixed #26701 -- Replaced /newticket links to Trac with /. 2016-06-03 08:48:12 -04:00
Tim Graham
abc5223834 Added a ticket tracker link in docs/internals/contributing/bugs-and-features.txt 2016-06-02 16:03:29 -04:00
Philip James
2c90981c5f Fixed #26699 -- Mentioned doc theming difference (locally-built vs. website). 2016-06-02 14:06:56 -04:00
Tim Graham
46a38307c2 Removed versionadded/changed annotations for 1.9. 2016-05-20 11:44:29 -04:00
Tim Graham
2e1d44e46d Fixed #26637 -- Removed obsolete note in docs/internals/contributing/writing-documentation.txt 2016-05-19 09:11:56 -04:00
Bas Westerbaan
a5033dbc58 Refs #26033 -- Added password hasher support for Argon2 v1.3.
The previous version of Argon2 uses encoded hashes of the form:
   $argon2d$m=8,t=1,p=1$<salt>$<data>

The new version of Argon2 adds its version into the hash:
   $argon2d$v=19$m=8,t=1,p=1$<salt>$<data>

This lets Django handle both version properly.
2016-04-25 21:17:53 -04:00
krishbharadwaj
361cb7a857 Fixed #26448 -- Added details for running tests with a different database backend. 2016-04-05 21:34:26 -04:00
Amine
8b5a4fa941 Fixed a broken link in docs/internals/contributing/writing-documentation.txt. 2016-03-19 16:19:01 -04:00
Tim Graham
460dab0b40 Removed obsolete section on "Improving the documentation". 2016-03-15 19:05:54 -04:00
Akshesh
44c0ecdd92 Fixed #25364 -- Added generic way to test on all browsers supported by selenium.
Browser names should be passed as a comma separated list to the --selenium flag.

Thanks Tim Graham, Simon Charette and Moritz Sichert for review and discussion.
2016-03-15 13:10:32 -04:00
Bas Westerbaan
b4250ea04a Fixed #26033 -- Added Argon2 password hasher. 2016-03-08 11:22:18 -05:00
Tim Graham
e19fc9f08a Removed claim that you can use different database backends for Django's tests.
Such as a setup isn't tested through continuous integration and therefore
isn't likely to work reliably.
2016-03-05 08:42:18 -05:00
Akshesh
6670da75ff Fixed #25653 -- Made --selenium run only the selenium tests. 2016-02-19 14:21:00 -05:00
Elif T. Kus
bca9faae95 Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
Tim Graham
e519aab43a Fixed #23868 -- Added support for non-unique django-admin-options in docs.
Also documented missing short command line options to fix #24134. This bumps
the minimum sphinx version required to build the docs to 1.3.4.

Thanks Simon Charette for review.
2016-01-14 18:21:33 -05:00
pp
b34ff66e5b Added missing period to "etc.". 2016-01-11 18:05:15 -05:00
Varun Sharma
3d6474e1a5 Fixed #25385 -- Allowed importing views.generic.View from views.View. 2016-01-11 08:18:44 -05:00
Simon Charette
7bb373e309 Refs #25746 -- Added a test utility to isolate inlined model registration.
Thanks to Tim for the review.
2016-01-06 20:00:07 -05:00
Marten Kenbeek
16411b8400 Fixed #26013 -- Moved django.core.urlresolvers to django.urls.
Thanks to Tim Graham for the review.
2015-12-31 14:21:29 -05:00
Tim Graham
df3d5b1d73 Fixed #26003 -- Added "how the documentation is organized" sections.
Thanks Daniele Procida for coauthoring.
2015-12-31 11:35:00 -05:00
Tim Graham
77f50c9cfc Fixed #25948 -- Added guidelines for SimpleTestCase.assertRaisesMessage() usage. 2015-12-23 07:29:06 -05:00
Jon Dufresne
7aabd62380 Fixed #25778 -- Updated docs links to use https when available. 2015-12-01 08:01:34 -05:00
Andrei Fokau
998894e1b9 Fixed #25764 -- Added support for serialization of enum.Enum in migrations.
Thanks Tim Graham for the review.
2015-11-19 17:21:12 -05:00
Tim Graham
101dbeb673 Corrected outdated information in submitting patches guide. 2015-11-16 09:59:56 -05:00
Tim Graham
21c82646fe Documented how to see the full traceback of a test failure. 2015-11-16 09:12:26 -05:00
Agnieszka Lasyk
1f8dad6915 Fixed #25755 -- Unified spelling of "website". 2015-11-16 06:44:14 -05:00
Curtis Maloney
35440ceab7 Optimized docs images and documented the process. 2015-10-24 14:57:21 -04:00
Yusuke Miyazaki
230d8c7301 Fixed #25578 -- Corrected the casing of "GitHub". 2015-10-21 07:31:11 -04:00
Tim Graham
54848a96dd Removed versionadded/changed annotations for 1.8. 2015-09-23 19:31:11 -04:00
David Gibbons
91e3d1215b Updated docs coverage example to run in a single process. 2015-09-16 08:20:29 -04:00
Aymeric Augustin
33c7c2a557 Enabled parallel testing by default in runtests.py. 2015-09-10 13:34:05 +02:00
Aymeric Augustin
6d1110f2f0 Updated references to the TEST_* database settings.
They were removed in Django 1.9.

I could leave the reference to TEST_DEPENDENCIES in the 1.2.4 release
notes because the link points to the right location and the name was
accurate at the time.
2015-09-05 19:21:22 +02:00
Aymeric Augustin
0eb846605e Recommend relative imports within Django components.
django-developers thread:
https://groups.google.com/d/msg/django-developers/11XvmVdx58w/sFrF0pL8LTgJ
2015-08-22 19:58:44 +02:00
Claude Paroz
e9c5c39631 Updated various links in docs 2015-08-08 13:57:15 +02:00
Claude Paroz
18f3d4c1bd Updated Transifex links in docs 2015-08-08 11:33:28 +02:00
Flavio Curella
7f0953ce1f Fixed #25184 -- Added support for MaxMind GeoLite2 database format 2015-07-31 09:45:03 -04:00
Tim Graham
adffff79a3 Allowed installing closure with pip for admin JavaScript compression. 2015-07-17 13:22:34 -04:00
Tim Graham
074706c64d Added a link to running the unit tests to new contributors page. 2015-07-10 11:02:25 -04:00
Tim Graham
0e3193a386 Updated mock note since Django no longer works with Python 3.2. 2015-07-03 08:24:58 -04:00
Tim Graham
ca58181bac Fixed #25056 -- Documented minimum version of jinja2 for testing. 2015-07-03 08:20:53 -04:00
Trey Hunner
2d0dead224 DEP 0003 -- Added JavaScript unit tests.
Setup QUnit, added tests, and measured test coverage.

Thanks to Nick Sanford for the initial tests.
2015-06-30 21:04:16 -04:00
Trey Hunner
ec4f219ecb Fixed #22463 -- Added code style guide and JavaScript linting (EditorConfig and ESLint) 2015-06-27 16:36:26 -04:00
Tim Graham
aed437d567 Updated release process for new release schedule. 2015-06-25 11:36:17 -04:00
Tim Graham
7f1168e387 Removed support for Python 3.3. 2015-06-18 08:36:50 -04:00
Tim Graham
ccfb5c7408 Removed obsolete literals_to_xrefs.py script. 2015-06-15 10:22:18 -04:00
Tim Graham
2fbea621e6 Capitalized "Python" in docs. 2015-06-05 08:24:53 -04:00
Steadman
dfdcb3ca22 Improved wording in writing documentation docs. 2015-06-04 11:58:32 +01:00
Dave Hodder
08c980d752 Updated capitalization in the word "JavaScript" for consistency 2015-05-01 13:26:42 -04:00
Carolina
118cae2df8 Fixed #23666 -- Recommended Git Bash for running unit tests on Windows. 2015-03-24 10:45:58 -04:00
Erik Romijn
f66c2bdc0f Fixed #23903 -- Configured Sphinx to autogenerate django-admin manpage 2015-03-10 08:12:09 -04:00
Sean Wang
eba6dff581 Fixed #24358 -- Corrected code-block directives for console sessions. 2015-02-22 09:35:39 -05:00
Tim Graham
d28bcba209 Fixed typo in docs/internals/contributing/triaging-tickets.txt 2015-02-20 07:26:16 -05:00
Tim Graham
dbacbc729a Simplified and updated committing code guidelines. 2015-02-19 20:36:24 -05:00
Tim Graham
0adf766e16 Fixed #23811 -- Added a guide for using git bisect. 2015-02-19 20:18:52 -05:00
Tim Graham
7cf3a5786b Updated docs and runtests.py for removal of tests from contrib. 2015-02-11 10:29:54 -05:00
Tim Graham
a3473454ad Updated docs on running selenium tests. 2015-02-10 12:30:28 -05:00
Tim Graham
6704b52980 Fixed #24269 -- Added docs about the process of managing translations in Django. 2015-02-09 13:07:45 -05:00
Peter Inglesby
a8f1c70dce Fixed docs typo 2015-02-07 18:46:04 +01:00
wrwrwr
cd155c7c71 Fixed #23860 -- Documented import order convention. 2015-02-06 14:48:56 -05:00
Riccardo Magliocchetti
9410d69835 Added cross references to contributing docs. 2015-02-05 10:40:46 -05:00
darkryder
9ec8aa5e5d Fixed #24149 -- Normalized tuple settings to lists. 2015-02-03 14:59:45 -05:00
Tim Graham
c79faae761 Removed versionadded/changed notes for 1.7. 2015-02-01 21:02:40 -05:00
Tim Graham
63412262e5 Fixed #24175 -- Updated docstring convention. 2015-01-29 12:21:44 -05:00
Marc Tamlyn
b5c1a85b50 Fixed #24118 -- Added --debug-sql option for tests.
Added a --debug-sql option for tests and runtests.py which outputs the
SQL logger for failing tests. When combined with --verbosity=2, it also
outputs the SQL for passing tests.

Thanks to Berker, Tim, Markus, Shai, Josh and Anssi for review and
discussion.
2015-01-12 08:16:08 +00:00
Tim Graham
7102b99653 Added best practices for versionadded/changed annotations. 2015-01-09 13:23:29 -05:00
Claude Paroz
66f9a74b45 Added ignore_warnings decorator
And removed Ignore*DeprecationWarningsMixin, now obsolete.
Thanks Berker Peksag and Tim Graham for the review.
2014-12-30 18:16:25 +01:00
Tim Graham
6571ed14b6 Fixed #24049 -- Removed obsolete Java notes for Mac OS. 2014-12-24 18:38:07 -05:00