mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-30 07:06:18 +01:00
Code Issues Releases Wiki Activity
5b8ef8aa5b
django/docs
History
Keryn Knight 5b8ef8aa5b Refs #32946 -- Changed Query.add_filter() to take two arguments.
2021-07-28 09:38:42 +02:00
..
_ext
_theme Fixed #32860 -- Made docs permalinks focusable to improve accessibility. 2021-06-21 13:47:26 +02:00
faq Refs #31356 -- Changed IRC links to the Libera.Chat webchat. 2021-06-03 12:07:30 +02:00
howto Refs #32956 -- Changed "afterwards" to "afterward" in docs and comments. 2021-07-27 10:41:51 +02:00
internals Refs #32956 -- Changed "afterwards" to "afterward" in docs and comments. 2021-07-27 10:41:51 +02:00
intro Refs #32338 -- Improved accessibility of RadioSelect examples in docs. 2021-06-04 08:28:25 +02:00
man
misc
ref Fixed #32933 -- Documented BoundField.initial as preferred over Form.get_initial_for_field(). 2021-07-27 16:47:09 +02:00
releases Refs #32946 -- Changed Query.add_filter() to take two arguments. 2021-07-28 09:38:42 +02:00
topics Refs #32956 -- Changed "afterwards" to "afterward" in docs and comments. 2021-07-27 10:41:51 +02:00
conf.py Refs #31676 -- Removed Django Core-Mentorship mailing list references in docs. 2021-07-13 20:21:22 +02:00
contents.txt
glossary.txt
index.txt
make.bat Added spelling option to make.bat. 2021-04-30 14:04:22 +02:00
Makefile
README.rst
requirements.txt
spelling_wordlist Changed IRC references to Libera.Chat. 2021-05-20 12:23:36 +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/