Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Mariusz Felisiak 6c0ee61797 [4.1.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+. 
sphinxcontrib-spelling 7.5.0+ includes captions of figures in the set
of nodes for which the text is checked.

Backport of ac90529cc58507d9a07610809a795ec5fc3cbf8c from main
2022-06-27 07:44:27 +02:00
..
_ext
Refs #33476 -- Refactored code to strictly match 88 characters line length.
2022-02-07 20:37:05 +01:00
_theme
[4.1.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-06-27 07:44:27 +02:00
faq
Removed hyphen from pre-/re- prefixes.
2022-04-28 10:44:14 +02:00
howto
[4.1.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-06-27 07:44:27 +02:00
internals
[4.1.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-06-27 07:44:27 +02:00
intro
[4.1.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-06-27 07:44:27 +02:00
man
Updated man page for Django 4.1 alpha.
2022-05-17 11:21:08 +02:00
misc
Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.
2021-07-29 06:24:12 +02:00
ref
[4.1.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-06-27 07:44:27 +02:00
releases
[4.1.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-06-27 07:44:27 +02:00
topics
[4.1.x] Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-06-27 07:44:27 +02:00
conf.py
[4.1.x] Bumped minimum Sphinx version to 4.5.0.
2022-05-31 15:24:10 +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 32956 -- Lowercased spelling of "web" and "web framework" where appropriate.
2021-07-29 06:24:12 +02:00
make.bat
Added spelling option to make.bat.
2021-04-30 14:04:22 +02:00
Makefile
[4.1.x] Fixed #33753 -- Fixed docs build on Sphinx 5+.
2022-06-01 12:13:38 +02:00
README.rst
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
requirements.txt
Rewrote strip_tags test file to lorem ipsum.
2022-03-08 14:50:06 +01:00
spelling_wordlist
[4.1.x] Fixed #33725 -- Made hidden quick filter in admin's navigation sidebar not focusable.
2022-05-21 14:36:02 +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.