mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-04-29 11:44:37 +00:00
Code Issues 32 Releases Wiki Activity
django/docs
History
Carlton Gibson a3a4a0baa3 [3.2.x] Corrected wrapping in 3.2 release notes. 
Partially reverts 0802b404a210862e6765a6c7dee6cba61085d7a6.
Backport of 5b05a45c62f4702a6039cd3de290320c232cb808 from main
2021-04-07 07:28:09 +02:00
..
_ext
Made default_role_error use logger.
2020-06-03 11:42:42 +02:00
_theme
Fixed #16300 -- Improved singlehtml docs formatting with headers CSS.
2020-06-22 21:05:13 +02:00
faq
Refs #31040 -- Doc'd Python 3.9 compatibility.
2020-10-13 08:35:01 +02:00
howto
[3.2.x] Refs #32105 -- Moved ExceptionReporter template paths to properties.
2021-03-31 09:11:39 +02:00
internals
[3.2.x] Updated asgiref dependency for 3.2 release series.
2021-04-06 10:43:40 +02:00
intro
[3.2.x] Updated Git branch "master" to "main".
2021-03-09 09:33:50 +01:00
man
[3.2.x] Updated manpage for Django 3.2 final.
2021-04-06 11:02:06 +02:00
misc
Expanded API stability docs to include our policy of continual improvement.
2019-11-18 20:37:46 +01:00
ref
[3.2.x] Refs #30156 -- Corrected version in SpatiaLite install instructions.
2021-04-06 12:45:15 +02:00
releases
[3.2.x] Corrected wrapping in 3.2 release notes.
2021-04-07 07:28:09 +02:00
topics
[3.2.x] Removed dead link in docs/topics/http/sessions.txt.
2021-03-30 06:42:12 +02:00
conf.py
[3.2.x] Updated Git branch "master" to "main".
2021-03-09 09:33:50 +01: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
Fixed #32018 -- Extracted admin colors into CSS variables.
2021-01-07 10:07:19 +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/