django/docs
Almaz Kunpeissov 5a3725594f
Corrected pycon formatting in some docs.
2023-08-01 08:46:44 +02:00
..
_ext
_theme
faq
howto Fixed #34309 -- Doc'd how to fully delete an app. 2023-07-11 10:48:01 +02:00
internals
intro Fixed typo in docs/intro/tutorial08.txt. 2023-06-28 07:08:51 +02:00
man
misc
ref Corrected pycon formatting in some docs. 2023-08-01 08:46:44 +02:00
releases Fixed #32820 -- Added aria-invalid="true" to fields with errors. 2023-08-01 06:08:04 +02:00
topics Fixed #34714 -- Added aget_object_or_404()/aget_list_or_404() shortcuts. 2023-07-24 07:37:54 +02:00
Makefile
README.rst
conf.py
contents.txt
glossary.txt
index.txt
make.bat
requirements.txt
spelling_wordlist Fixed #33405, Refs #7177 -- Clarified docs for filter escapejs regarding safe and unsafe usages. 2023-07-03 12:32:58 +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/