Go to file
Carlton Gibson 9a4a2b2089 [2.2.x] Refs #33247 -- Corrected configuration for Read The Docs.
This pins Sphinx version, because the default Sphinx version used by
RTD is not compatible with Python 3.8+.

This also, sets Python 3.8 for RTD builds which is compatible with all
current versions of Django.

Thanks to Mariusz Felisiak for the suggestion.

Backport of 447b6c866f from main.
2021-11-03 19:05:19 +01:00
.tx Removed contrib-messages entry in Transifex config file 2016-06-29 21:11:30 +02:00
django [2.2.x] Post-release version bump. 2021-06-02 10:36:52 +02:00
docs [2.2.x] Refs #33247 -- Corrected configuration for Read The Docs. 2021-11-03 19:05:19 +01:00
extras Refs #23919 -- Removed Python 2 reference in django_bash_completion. 2017-07-10 08:54:52 -04:00
js_tests [2.2.x] Bumped minimum ESLint version to 4.18.2. 2019-06-21 18:00:32 +02:00
scripts Capitalized "Python" in docs and comments. 2018-10-09 09:26:07 -04:00
tests [2.2.x] Fixed #33082 -- Fixed CommandTests.test_subparser_invalid_option on Python 3.9.7+. 2021-09-02 11:06:10 +02:00
.editorconfig Refs #29784 -- Switched to https:// links where available. 2018-09-26 08:48:47 +02:00
.eslintignore Refs #16501, #26474 -- Added xregexp.js source file. 2016-06-06 09:25:02 -04:00
.eslintrc Fixed #25165 -- Removed inline JavaScript from the admin. 2015-12-05 15:51:57 -05: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
.hgignore Synced .hgignore with .gitignore 2015-07-01 10:23:05 -04:00
.readthedocs.yml [2.2.x] Refs #33247 -- Corrected configuration for Read The Docs. 2021-11-03 19:05:19 +01:00
AUTHORS [2.2.x] Fixed #31850 -- Fixed BasicExtractorTests.test_extraction_warning with xgettext 0.21+. 2020-11-02 10:30:40 +01:00
CONTRIBUTING.rst Added link to the code of conduct from contributing guides. 2015-04-17 18:12:41 -04:00
Gruntfile.js Fixed qunit tests (coverage still missing). (#7716) 2016-12-19 18:45:37 +01:00
INSTALL [2.2.x] Refs #30948 -- Updated install instructions to use pip instead of setup.py. 2019-11-08 21:17:38 +01:00
LICENSE Whitespace cleanup. 2013-10-10 16:49:20 -04:00
LICENSE.python Fixed #29261 -- Doc'd the reason for LICENSE.python. 2018-06-29 20:00:58 -04:00
MANIFEST.in Simplified MANIFEST.in 2015-12-12 12:07:21 -05:00
README.rst [2.2.x] Changed IRC references to Libera.Chat. 2021-05-20 12:42:48 +02:00
package.json [2.2.x] Bumped minimum ESLint version to 4.18.2. 2019-06-21 18:00:32 +02:00
setup.cfg Ignored flake8 W504 warnings. 2018-10-24 09:17:59 -04:00
setup.py [2.2.x] Refs #31040 -- Doc'd Python 3.9 compatibility. 2020-10-13 08:45:37 +02:00
tox.ini [2.2.x] Refs #31040 -- Doc'd Python 3.9 compatibility. 2020-10-13 08:45:37 +02:00

README.rst

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
  out there. See https://en.wikipedia.org/wiki/Wikipedia:IRC/Tutorial 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