1
0
mirror of https://github.com/django/django.git synced 2025-01-09 09:55:57 +00:00
django/docs
Shai Berger 42cd8c390d Fixed #33986 -- Hardened binary lookup in template commands.
Made template commands look up formatters before writing files.
This makes sure files included in the template are not identified
as executable formatter commands, even in case the template is
rendered into the system path (as might easily happen on Windows,
where the current directory is on the system path by default).

While at it, Warned about trusting custom templates for
startapp/startproject.

Thanks Trung Pham of Viettel Cyber Security for reporting the issue,
Django Security Team for discussions, and Adam Johnson and
Carlton Gibson for reviews.
2022-09-07 11:08:43 +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 #33842 -- Used :source: role for links to repo files on GitHub. 2022-08-09 14:44:51 +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 #33986 -- Hardened binary lookup in template commands. 2022-09-07 11:08:43 +02:00
releases Fixed #33982 -- Fixed migrations crash when adding model with ExclusionConstraint. 2022-09-07 08:40:56 +02:00
topics Fixed #33616 -- Allowed registering callbacks that can fail in transaction.on_commit(). 2022-09-06 12:21:36 +02:00
conf.py Bumped minimum Sphinx version to 4.5.0. 2022-05-31 15:21:17 +02:00
contents.txt
glossary.txt
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
requirements.txt Rewrote strip_tags test file to lorem ipsum. 2022-03-08 14:50:06 +01:00
spelling_wordlist Added Central Kurdish (Sorani) language. 2022-08-30 11:56:11 +02:00

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/