Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Howard Cox cd413bd78a Fixed #34621 -- Made admin site header render in <div> tag. 
This was problematic for screen reader users because they use headings
to navigate. Having two <h1> is confusing, and the one in the header
wasn’t particularly helpful since it’s the same on all pages.
2023-06-05 11:55:06 +02:00
..
_ext
Removed unnecessary workarounds for Sphinx < 4.3.0.
2023-05-04 13:55:06 +02:00
_theme
Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-05-31 11:17:01 +02:00
faq
Fixed #34545 -- Corrected the number of months in installation FAQ.
2023-05-08 08:34:23 +02:00
howto
Updated broken links in docs.
2023-05-17 12:13:10 +02:00
internals
Fixed #34579 -- Added Django Forum to contributing guides.
2023-05-22 20:21:18 +02:00
intro
Fixed #34621 -- Made admin site header render in <div> tag.
2023-06-05 11:55:06 +02:00
man
Updated man page for Django 4.2 alpha.
2023-01-17 08:51:17 +01:00
misc
Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.
2021-07-29 06:24:12 +02:00
ref
Fixed #34621 -- Made admin site header render in <div> tag.
2023-06-05 11:55:06 +02:00
releases
Fixed #34621 -- Made admin site header render in <div> tag.
2023-06-05 11:55:06 +02:00
topics
Refs #23528 -- Made cosmetic edits to swappable_dependency() docs.
2023-06-03 12:01:15 +02:00
conf.py
Used extlinks for PyPI links.
2023-04-17 06:55:32 +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
Added Django Forum to mailing lists page.
2023-03-24 08:32:17 +01:00
make.bat
Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
2023-03-01 13:02:57 +01:00
Makefile
Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
2023-03-01 13:02:57 +01:00
README.rst
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
requirements.txt
Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs.
2023-03-01 13:02:57 +01:00
spelling_wordlist
Fixed #34574 -- Noted unexpected outcomes in autoescape/escape docs.
2023-05-26 06:21:46 +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.