Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Nick Pope 80cf193d32 [3.2.x] Refs #32720 -- Used :commit: and :source: role in old release notes. 
Backport of 8c4caee76a5571c6c8050660a6a9fc30ece6678d from main
2021-05-17 12:13:31 +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
[3.2.x] Fixed #32652 -- Fixed links to new contributors FAQ.
2021-04-15 17:16:22 +02:00
howto
[3.2.x] Fixed #26721 -- Doc'd setting UTF-8 on Windows.
2021-05-12 20:46:31 +02:00
internals
[3.2.x] Fixed typo in docs/internals/contributing/writing-documentation.txt.
2021-05-06 20:02:11 +02:00
intro
[3.2.x] Refs #28034 -- Corrected docs example in contributing tutorial.
2021-04-23 15:25:12 +02: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] Fixed a typo in docs/ref/models/fields.txt.
2021-05-12 12:12:10 +02:00
releases
[3.2.x] Refs #32720 -- Used :commit: and :source: role in old release notes.
2021-05-17 12:13:31 +02:00
topics
[3.2.x] Refs #32366 -- Avoided use of datetime.utcnow() in the documentation.
2021-05-12 12:12:28 +02:00
conf.py
[3.2.x] Bumped django_next_version in docs config.
2021-04-10 19:06:18 +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
[3.2.x] Added spelling option to make.bat.
2021-04-30 14:09:59 +02: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.