django/docs
Jon Dufresne 2dd4d110c1 Fixed CVE-2020-13596 -- Fixed potential XSS in admin ForeignKeyRawIdWidget. 2020-06-03 09:23:00 +02:00
..
_ext
_theme
faq Corrected FAQ link in docs/faq/help.txt. 2020-05-29 21:23:25 +02:00
howto Fixed #31643 -- Changed virtualenv doc references to Python 3 venv. 2020-06-02 11:45:44 +02:00
internals Fixed #31643 -- Changed virtualenv doc references to Python 3 venv. 2020-06-02 11:45:44 +02:00
intro Adjusted URL example in tutorial. 2020-06-02 12:26:30 +02:00
man
misc
ref Fixed typo in docs/ref/templates/language.txt. 2020-06-01 20:51:54 +02:00
releases Fixed CVE-2020-13596 -- Fixed potential XSS in admin ForeignKeyRawIdWidget. 2020-06-03 09:23:00 +02:00
topics Updated link to Celery. 2020-06-02 14:37:16 +02:00
Makefile
README.rst
conf.py
contents.txt
glossary.txt
index.txt
make.bat
spelling_wordlist Fixed #31643 -- Changed virtualenv doc references to Python 3 venv. 2020-06-02 11:45:44 +02: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/