mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-29 22:56:46 +01:00
Code Issues Releases Wiki Activity
fbdb032de2
django/docs
History
Nick Pope fbdb032de2 Used :envvar: role and .. envvar:: directive in various docs.
2020-05-13 09:14:40 +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 Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +02:00
howto Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +02:00
internals Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +02:00
intro Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +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 Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +02:00
releases Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +02:00
topics Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +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 Capitalized Unicode in docs, strings, and comments. 2020-04-20 12:10:33 +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/