1
0
mirror of https://github.com/django/django.git synced 2024-12-22 17:16:24 +00:00
django/docs
Jon Dufresne 8dabdd2cc5
Corrected FAQ link in docs/faq/help.txt.
Without the leading slash, was pointing to Python's FAQ
https://docs.python.org/3/faq/index.html.
2020-05-29 21:23:25 +02:00
..
_ext Changed '%s' % value pattern to str(value). 2020-05-04 08:27:18 +02:00
_theme Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags. 2019-12-11 09:49:54 +01:00
faq Corrected FAQ link in docs/faq/help.txt. 2020-05-29 21:23:25 +02:00
howto Changed some doc links to use intersphinx. 2020-05-29 21:09:57 +02:00
internals Doc'd release step for new classifiers on PyPI. 2020-05-21 22:34:21 +02:00
intro Fixed #31628 -- Updated Windows install guide to recommend venv. 2020-05-27 11:18:23 +02:00
man Updated man page for Django 3.1 alpha. 2020-05-12 11:26:37 +02:00
misc
ref Fixed #28694 -- Made django.utils.text.slugify() strip dashes and underscores. 2020-05-29 06:47:51 +02:00
releases Fixed #28694 -- Made django.utils.text.slugify() strip dashes and underscores. 2020-05-29 06:47:51 +02:00
topics Changed some doc links to use intersphinx. 2020-05-29 21:09:57 +02:00
conf.py Bumped version; master is now 3.2 pre-alpha. 2020-05-13 09:07:51 +02:00
contents.txt
glossary.txt
index.txt Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02: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 Added Kyrgyz language. 2020-05-20 12:29:59 +02:00

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/