p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
django/docs
History
tim-mccurrach 6eb01cb052 [3.1.x] Fixed #32576 -- Corrected dumpdata docs for passing model names to the --exclude option. 
Backport of cf2f6fc558 from main
 		2021-03-22 08:45:20 +01:00
..
_ext [3.1.x] Made default_role_error use logger. 2020-06-03 11:43:37 +02:00
_theme Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags. 2019-12-11 09:49:54 +01:00
faq [3.1.x] Refs #31040 -- Doc'd Python 3.9 compatibility. 2020-10-13 08:36:43 +02:00
howto [3.1.x] Updated links to DEPs. 2021-02-25 17:27:54 +01:00
internals [3.1.x] Updated links to djangoproject.com/code.djangoproject.com repositories. 2021-03-03 09:07:33 +01:00
intro [3.1.x] Refs #32412 -- Adjusted link from tutorial to reference docs. 2021-02-04 10:39:22 +01:00
man [3.1.x] Updated man page for Django 3.1 beta. 2020-06-15 09:52:09 +02:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref [3.1.x] Fixed #32576 -- Corrected dumpdata docs for passing model names to the --exclude option. 2021-03-22 08:45:20 +01:00
releases [3.1.x] Fixed #32560 -- Fixed test runner with --pdb and --buffer on fail/error. 2021-03-17 21:51:51 +01:00
topics [3.1.x] Refs #25735 -- Added tags/exclude_tags arguments to DiscoverRunner docs. 2021-03-19 08:11:22 +01:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py [3.1.x] Added documentation extlink for bugs.python.org. 2021-02-17 14:26:48 +01:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02:00
make.bat
…
spelling_wordlist [3.1.x] Fixed #32273 -- Doc'd AdminSite.unregister(). 2020-12-16 08:10:44 +01:00

README.rst 

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

It uses `ReST`_ (reStructuredText), and the `Sphinx`_ documentation system.
This allows it to be built into other forms for easier viewing and browsing.

To create an HTML version of the docs:

* Install Sphinx (using ``python -m pip install Sphinx`` or some other method).

* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  Windows) at a shell prompt.

The documentation in ``_build/html/index.html`` can then be viewed in a web
browser.

.. _ReST: https://docutils.sourceforge.io/rst.html
.. _Sphinx: https://www.sphinx-doc.org/