Go to file
Mariusz Felisiak 1a9098166e [3.2.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+.
sphinxcontrib-spelling 7.5.0+ includes captions of figures in the set
of nodes for which the text is checked.

Backport of ac90529cc5 from main.
2022-06-27 08:10:48 +02:00
.github Enabled GitHub security policy. 2020-05-07 17:25:46 +02:00
.tx Removed contrib-messages entry in Transifex config file 2016-06-29 21:11:30 +02:00
django [3.2.x] Post-release version bump. 2022-04-11 09:21:27 +02:00
docs [3.2.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-06-27 08:10:48 +02:00
extras Fixed #23433 -- Deprecated django-admin.py entry point in favor of django-admin. 2019-12-06 12:11:44 +01:00
js_tests Fixed #32062 -- Added %b support to Date.strftime. 2020-10-28 11:11:37 +01:00
scripts Refs #30116 -- Simplified stdout/stderr decoding with subprocess.run()'s encoding argument. 2019-11-04 11:21:25 +01:00
tests [3.2.x] Fixed test_request_lifecycle_signals_dispatched_with_thread_sensitive with asgiref 3.5.1+. 2022-06-22 10:02:31 +02:00
.editorconfig Refs #29784 -- Switched to https:// links where available. 2018-09-26 08:48:47 +02:00
.eslintignore Refs #31265 -- Updated .eslintignore to match eslint tests 2020-12-23 11:14:48 +01:00
.eslintrc Enabled ESLint's "eqeqeq" rule. 2020-05-18 07:42:51 +02:00
.gitattributes Fixed #19670 -- Applied CachedFilesMixin patterns to specific extensions 2016-03-30 14:34:41 +02:00
.gitignore Fixed #22446 -- Added tox.ini to automate pull request checks. 2016-07-20 14:06:28 -04:00
.pre-commit-config.yaml Fixed #32165 -- Added pre-commit hooks 2020-12-23 11:14:48 +01:00
.readthedocs.yml [3.2.x] Configured Read The Docs to build all formats. 2021-11-18 12:24:34 +01:00
AUTHORS [3.2.x] Fixed #32947 -- Fixed hash() crash on reverse M2M relation when through_fields is a list. 2021-07-26 06:41:31 +02:00
CONTRIBUTING.rst Added link to the code of conduct from contributing guides. 2015-04-17 18:12:41 -04:00
Gruntfile.js Refs #31265 -- Updated .eslintignore to match eslint tests 2020-12-23 11:14:48 +01:00
INSTALL Refs #30948 -- Updated install instructions to use pip instead of setup.py. 2019-11-08 13:26:35 +01:00
LICENSE Whitespace cleanup. 2013-10-10 16:49:20 -04:00
LICENSE.python Updated Python license for 2020. 2020-02-04 11:58:12 +01:00
MANIFEST.in Fixed #31524 -- Removed minified static assets from the admin. 2020-05-14 16:07:56 +02:00
README.rst [3.2.x] Refs #31356 -- Changed IRC links to the Libera.Chat webchat. 2021-06-03 12:08:56 +02:00
package.json Removed bundled QUnit in favor of npm package. 2020-03-17 15:43:59 +01:00
setup.cfg [3.2.x] Refs #32074 -- Added Python 3.10 to classifiers and tox.ini. 2021-10-05 12:40:33 +02:00
setup.py Fixed #30948 -- Changed packaging to use declarative config in setup.cfg. 2019-11-08 14:14:13 +01:00
tox.ini [3.2.x] Refs #32074 -- Added Python 3.10 to classifiers and tox.ini. 2021-10-05 12:40:33 +02:00

README.rst

======
Django
======

Django is a high-level Python Web framework that encourages rapid development
and clean, pragmatic design. Thanks for checking it out.

All documentation is in the "``docs``" directory and online at
https://docs.djangoproject.com/en/stable/. If you're just getting started,
here's how we recommend you read the docs:

* First, read ``docs/intro/install.txt`` for instructions on installing Django.

* Next, work through the tutorials in order (``docs/intro/tutorial01.txt``,
  ``docs/intro/tutorial02.txt``, etc.).

* If you want to set up an actual deployment server, read
  ``docs/howto/deployment/index.txt`` for instructions.

* You'll probably want to read through the topical guides (in ``docs/topics``)
  next; from there you can jump to the HOWTOs (in ``docs/howto``) for specific
  problems, and check out the reference (``docs/ref``) for gory details.

* See ``docs/README`` for instructions on building an HTML version of the docs.

Docs are updated rigorously. If you find any problems in the docs, or think
they should be clarified in any way, please take 30 seconds to fill out a
ticket here: https://code.djangoproject.com/newticket

To get more help:

* Join the ``#django`` channel on ``irc.libera.chat``. Lots of helpful people
  hang out there. See https://web.libera.chat if you're new to IRC.

* Join the django-users mailing list, or read the archives, at
  https://groups.google.com/group/django-users.

To contribute to Django:

* Check out https://docs.djangoproject.com/en/dev/internals/contributing/ for
  information about getting involved.

To run Django's test suite:

* Follow the instructions in the "Unit tests" section of
  ``docs/internals/contributing/writing-code/unit-tests.txt``, published online at
  https://docs.djangoproject.com/en/dev/internals/contributing/writing-code/unit-tests/#running-the-unit-tests

Supporting the Development of Django
====================================

Django's development depends on your contributions. 

If you depend on Django, remember to support the Django Software Foundation: https://www.djangoproject.com/fundraising/