mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-07-24 05:36:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
django/docs
History
Mariusz Felisiak 9fb9944d1c [3.1.x] Refs #32718 -- Corrected CVE-2021-31542 release notes. 
Backport of d1f1417cae from main.
2021-05-12 10:43:12 +02:00
..
_ext
_theme
faq
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
misc
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] Refs #32718 -- Corrected CVE-2021-31542 release notes. 2021-05-12 10:43:12 +02:00
topics [3.1.x] Refs #25735 -- Added tags/exclude_tags arguments to DiscoverRunner docs. 2021-03-19 08:11:22 +01:00
conf.py [3.1.x] Added documentation extlink for bugs.python.org. 2021-02-17 14:26:48 +01:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
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/