Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Nick Pope 058b38b43e
Improved message example in admin actions documentation. 
Avoid partial string construction and make use of ``ngettext`` to show
example of how to handle plural variants with translations. Also make
use of ``messages.SUCCESS`` to highlight customizing the style of the
message - in this case it better fits what the message is conveying.
2020-04-16 11:26:33 +02:00
..
_ext
Sorted imports in docs/_ext/djangodocs.py.
2020-04-14 07:31:36 +02:00
_theme
Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags.
2019-12-11 09:49:54 +01:00
faq
Prevented (and corrected) single backtick usage in docs.
2020-04-01 14:55:11 +02:00
howto
Refs #29501 -- Allowed customizing exit status for management commands.
2020-04-14 13:22:47 +02:00
internals
Refs #27468 -- Changed default Signer algorithm to SHA-256.
2020-04-15 12:49:14 +02:00
intro
Fixed term warning on Sphinx 3.0.1+.
2020-04-14 09:32:09 +02:00
man
Updated man page for 3.0 alpha release.
2019-09-10 10:10:50 +02:00
misc
Expanded API stability docs to include our policy of continual improvement.
2019-11-18 20:37:46 +01:00
ref
Improved message example in admin actions documentation.
2020-04-16 11:26:33 +02:00
releases
Refs #27468 -- Changed default Signer algorithm to SHA-256.
2020-04-15 12:49:14 +02:00
topics
Used :rfc: role in various docs.
2020-04-15 18:31:30 +02:00
conf.py
Prevented (and corrected) single backtick usage in docs.
2020-04-01 14:55:11 +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
Rewrote Get Help FAQ.
2020-03-26 09:44:00 +01: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
Corrected docs spelling of PgBouncer.
2020-04-01 14:55:11 +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.