mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-01-10 10:26:34 +00:00
Code Issues 32 Releases Wiki Activity
8c4caee76a
django/docs
History
Nick Pope 8c4caee76a Refs #32720 -- Used :commit: and :source: role in old release notes.
2021-05-17 07:36:57 +02:00
..
_ext
_theme
faq Fixed #32652 -- Fixed links to new contributors FAQ. 2021-04-15 17:14:22 +02:00
howto Fixed #26721 -- Doc'd setting UTF-8 on Windows. 2021-05-12 20:46:01 +02:00
internals Fixed #32738 -- Deprecated django.utils.datetime_safe module. 2021-05-12 14:42:17 +02:00
intro Refs #28034 -- Corrected docs example in contributing tutorial. 2021-04-23 15:24:16 +02:00
man Updated django-admin man page for Django 3.2. 2021-01-14 14:58:28 +01:00
misc
ref Fixed #32031 -- Added model class for each model to AdminSite.each_context(). 2021-05-13 06:57:09 +02:00
releases Refs #32720 -- Used :commit: and :source: role in old release notes. 2021-05-17 07:36:57 +02:00
topics Refs #32366 -- Avoided use of datetime.utcnow() in the documentation. 2021-05-12 11:06:31 +02:00
conf.py Updated Git branch "master" to "main". 2021-03-09 08:48:32 +01: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 Used GitHub actions for docs tests. 2021-02-26 22:12:25 +01:00
spelling_wordlist Fixed #32670 -- Allowed GDALRasters to use any GDAL virtual filesystem. 2021-05-07 20:03:46 +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/