mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-22 03:18:31 +01:00
Code Issues Releases Wiki Activity
965d2d95c6
django/docs
History
Thomas Güttler e251dd8230 Added python_requires/install_requires to setup.cfg example in reusable apps docs.
2020-12-15 07:24:16 +01:00
..
_ext
_theme
faq Refs #31040 -- Doc'd Python 3.9 compatibility. 2020-10-13 08:35:01 +02:00
howto Fixed #31216 -- Added support for colorama terminal colors on Windows. 2020-11-11 14:27:10 +01:00
internals Fixed #32193 -- Deprecated MemcachedCache. 2020-12-09 21:27:32 +01:00
intro Added python_requires/install_requires to setup.cfg example in reusable apps docs. 2020-12-15 07:24:16 +01:00
man
misc
ref Added backticks to code literals in various docs. 2020-12-15 07:19:00 +01:00
releases Added backticks to code literals in various docs. 2020-12-15 07:19:00 +01:00
topics Added backticks to code literals in various docs. 2020-12-15 07:19:00 +01:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
spelling_wordlist Fixed #31216 -- Added support for colorama terminal colors on Windows. 2020-11-11 14:27:10 +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/