mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-10-24 06:06:09 +00:00
Code Issues 32 Releases Wiki Activity
Files
69a78a4a63ca70f77d2d6003bb6b563cc6dbab34
django/docs
History
Mariusz Felisiak 4339f2aff2 Refs #31682 -- Doc'd minimal sqlparse version in Django 2.2. 
Support for sqlparse < 0.2.2 was broken in
40b0a58f5f because is_whitespace property
was added in sqlparse 0.2.2.
2020-06-10 06:53:32 +02:00
..
_ext
Made default_role_error use logger.
2020-06-03 11:42:42 +02:00
_theme
Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags.
2019-12-11 09:49:54 +01:00
faq
Removed reference to unsupported versions of Django and Python.
2020-06-03 21:28:14 +02:00
howto
Preferred usage of among/while to amongst/whilst.
2020-06-03 21:02:48 +02:00
internals
Fixed #31643 -- Changed virtualenv doc references to Python 3 venv.
2020-06-02 11:45:44 +02:00
intro
Updated How to install Django on Windows guide.
2020-06-03 16:28:10 +02:00
man
Updated man page for Django 3.1 alpha.
2020-05-12 11:26:37 +02:00
misc
Expanded API stability docs to include our policy of continual improvement.
2019-11-18 20:37:46 +01:00
ref
Fixed #20347 -- Allowed customizing the maximum number of instantiated forms in formsets.
2020-06-05 12:01:32 +02:00
releases
Refs #31682 -- Doc'd minimal sqlparse version in Django 2.2.
2020-06-10 06:53:32 +02:00
topics
Fixed #20347 -- Allowed customizing the maximum number of instantiated forms in formsets.
2020-06-05 12:01:32 +02:00
conf.py
Bumped version; master is now 3.2 pre-alpha.
2020-05-13 09:07:51 +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
Fixed #25712 -- Reorganized templates docs.
2020-04-30 08:12:09 +02:00
make.bat
…
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
spelling_wordlist
Preferred usage of among/while to amongst/whilst.
2020-06-03 21:02:48 +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/