1
0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
django/docs
2024-11-06 17:03:21 +01:00
..
_ext
_theme
faq Refs #34900 -- Doc'd Python 3.13 compatibility. 2024-10-09 09:27:33 +02:00
howto Updated authentication solutions list on using REMOTE_USER how-to. 2024-10-24 09:54:55 +02:00
internals Fixed #35863 -- Replaced bold text with heading level 3 in new contributors docs. 2024-11-06 17:03:21 +01:00
intro Added missing lang attributes to html elements in docs. 2024-10-30 14:02:30 +01:00
man
misc
ref Fixed #27409 -- Made admindocs support custom link text in docstrings. 2024-11-06 14:39:18 +01:00
releases Fixed #27409 -- Made admindocs support custom link text in docstrings. 2024-11-06 14:39:18 +01:00
topics Added missing lang attributes to html elements in docs. 2024-10-30 14:02:30 +01:00
conf.py Fixed docs build on Sphinx 8.1+. 2024-10-11 17:14:02 +02:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile Used webbroswer module in docs Makefile. 2024-10-24 10:45:44 +02:00
README.rst
requirements.txt
spelling_wordlist Expanded contributor docs on getting feedback from the wider community. 2024-10-16 13:23:19 +02:00

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/