mirrors
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues 24 Releases Wiki Activity
django/docs
History
Tim Schilling 34a69c2458 Corrected outputting BooleanField as HTML in forms docs. 2020-04-24 09:08:05 +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 Made compress.py script use the official google-closure-compiler release. 2020-04-22 16:19:27 +02:00
intro Fixed typo in docs/intro/contributing.txt. 2020-04-24 08:00:16 +02:00
man Updated man page for 3.0 alpha release. 2019-09-10 10:10:50 +02:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref Corrected outputting BooleanField as HTML in forms docs. 2020-04-24 09:08:05 +02:00
releases Updated admin's XRegExp to 3.2.0. 2020-04-22 08:45:14 +02:00
topics Doc'd PasswordChangeView/PasswordResetView.success_url defaults. 2020-04-24 08:21:51 +02:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py Prevented (and corrected) single backtick usage in docs. 2020-04-01 14:55:11 +02:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Rewrote Get Help FAQ. 2020-03-26 09:44:00 +01:00
make.bat
…
spelling_wordlist Capitalized Unicode in docs, strings, and comments. 2020-04-20 12:10:33 +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/