mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-01 07:31:48 +01:00
Code Issues Releases Wiki Activity
fb21625270
django/docs
History
Jon Dufresne fb21625270
Refs #30165 -- Removed obsolete doc references to deprecated ugettext() & co. 
The u-prefixed variants were removed from the documentation in
6eb4996672.
2020-04-20 07:57:24 +02:00
..
_ext Sorted imports in docs/_ext/djangodocs.py. 2020-04-14 07:31:36 +02:00
_theme Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags. 2019-12-11 09:49:54 +01:00
faq Prevented (and corrected) single backtick usage in docs. 2020-04-01 14:55:11 +02:00
howto Refs #29501 -- Allowed customizing exit status for management commands. 2020-04-14 13:22:47 +02:00
internals Refs #27468 -- Changed default Signer algorithm to SHA-256. 2020-04-15 12:49:14 +02:00
intro Fixed term warning on Sphinx 3.0.1+. 2020-04-14 09:32:09 +02:00
man
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref Refs #30165 -- Removed obsolete doc references to deprecated ugettext() & co. 2020-04-20 07:57:24 +02:00
releases Fixed #31477 -- Removed "using" argument from DatabaseOperations.execute_sql_flush(). 2020-04-20 07:49:35 +02:00
topics Refs #30165 -- Removed obsolete doc references to deprecated ugettext() & co. 2020-04-20 07:57:24 +02:00
conf.py Prevented (and corrected) single backtick usage in docs. 2020-04-01 14:55:11 +02:00
contents.txt
glossary.txt
index.txt Rewrote Get Help FAQ. 2020-03-26 09:44:00 +01:00
make.bat
Makefile
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
spelling_wordlist Corrected docs spelling of PgBouncer. 2020-04-01 14:55:11 +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/