Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Nick Pope 15d76dc2ab [3.1.x] Used :pep: role in various docs. 
Backport of a9337b4add01e50ed8ff8d3ef44099a08cba475c from master
2020-05-13 09:38: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
Refs #30573 -- Rephrased "Of Course" and "Obvious(ly)" in documentation and comments.
2020-05-04 12:10:47 +02:00
howto
[3.1.x] Used :pep: role in various docs.
2020-05-13 09:38:40 +02:00
internals
[3.1.x] Used :pep: role in various docs.
2020-05-13 09:38:40 +02:00
intro
Fixed #31495 - Corrected note about admin i18n in tutorial.
2020-05-06 16:19:04 +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
[3.1.x] Used :pep: role in various docs.
2020-05-13 09:38:40 +02:00
releases
[3.1.x] Used :pep: role in various docs.
2020-05-13 09:38:40 +02:00
topics
[3.1.x] Used :pep: role in various docs.
2020-05-13 09:38:40 +02:00
conf.py
[3.1.x] Bumped django_next_version in docs config.
2020-05-12 11:40:57 +02:00
contents.txt
Fixed #26020 -- Normalized header stylings in docs.
2016-01-22 12:12:17 -05:00
glossary.txt
Fixed #26020 -- Normalized header stylings in docs.
2016-01-22 12:12:17 -05:00
index.txt
Fixed #25712 -- Reorganized templates docs.
2020-04-30 08:12:09 +02:00
make.bat
Fixed #19516 - Fixed remaining broken links.
2013-01-02 18:32:57 -05:00
Makefile
Fixed docs build with Sphinx 1.6.
2017-05-24 09:13:26 -04:00
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.