Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
sarahboyce 3fb9c74d13 Bumped minimum Sphinx version to 4.5.0 in docs/requirements.txt. 
Follow up to ebf25555bbed3e9112d4b726575d60b242daf48a.
2022-09-26 11:18:15 +02:00
..
_ext
Refs #33476 -- Refactored code to strictly match 88 characters line length.
2022-02-07 20:37:05 +01:00
_theme
Fixed docs build with sphinxcontrib-spelling 7.5.0+.
2022-05-31 11:17:01 +02:00
faq
Added stub release notes for 4.2.
2022-05-17 14:22:06 +02:00
howto
Fixed #26975 -- Clarified how Django looks for fixture files.
2022-09-25 21:37:21 +02:00
internals
Fixed #33924 -- Deprecated BaseGeometryWidget.map_height/map_width attributes.
2022-08-12 13:26:35 +02:00
intro
Refs #30947 -- Changed tuples to lists where appropriate.
2022-08-30 09:57:17 +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
Fixed #34018 -- Fixed typo in docs/ref/contrib/flatpages.txt.
2022-09-16 15:12:45 +02:00
releases
Refs #34041 -- Added navigation landmark to breadcrumbs in admin.
2022-09-26 08:51:15 +02:00
topics
Fixed #34017 -- Doc'd that Argon2id variant is used by Argon2PasswordHasher.
2022-09-17 09:49:09 +02:00
conf.py
Bumped minimum Sphinx version to 4.5.0.
2022-05-31 15:21:17 +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
Fixed #33753 -- Fixed docs build on Sphinx 5+.
2022-06-01 12:13:15 +02:00
README.rst
Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:04:15 +01:00
requirements.txt
Bumped minimum Sphinx version to 4.5.0 in docs/requirements.txt.
2022-09-26 11:18:15 +02:00
spelling_wordlist
Added Central Kurdish (Sorani) language.
2022-08-30 11:56: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.