mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-23 01:25:58 +00:00
Code Issues 25 Releases Wiki Activity
c25a8c77d7
django/docs
History
Takuya Noguchi c25a8c77d7 Fixed #31241 -- Clarified porting translations of the Django docs to docs.djangoproject.com.
2020-02-12 08:41:48 +01:00
..
_ext Fixed #31025 -- Fixed highlightlinenothreshold deprecation warning on Sphinx 1.8+. 2019-11-25 10:33:33 +01:00
_theme Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags. 2019-12-11 09:49:54 +01:00
faq Fixed #23433 -- Deprecated django-admin.py entry point in favor of django-admin. 2019-12-06 12:11:44 +01:00
howto Simplified imports from django.db and django.contrib.gis.db. 2020-02-04 13:20:06 +01:00
internals Fixed #31241 -- Clarified porting translations of the Django docs to docs.djangoproject.com. 2020-02-12 08:41:48 +01:00
intro Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01: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 Reverted "Fixed #30565 -- Closed HttpResponse when wsgi.file_wrapper closes file-like object." 2020-02-11 20:39:12 +01:00
releases Fixed #31246 -- Fixed locking models in QuerySet.select_for_update(of=()) for related fields and parent link fields with multi-table inheritance. 2020-02-11 20:43:57 +01:00
topics Refs #31055 -- Made DiscoverRunner skip running system checks on unused test databases. 2020-02-07 11:01:31 +01:00
conf.py Fixed #28290 -- Enabled Sphinx auto-label generation for title and section headers. 2020-01-29 14:34:14 +01:00
contents.txt
glossary.txt
index.txt Fixed typo in docs/index.txt. 2020-01-03 07:53:31 +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 Fixed #31056 -- Allowed disabling async-unsafe check with an environment variable. 2019-12-03 17:29:31 +01: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/