mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-01-11 19:06:26 +00:00
Code Issues 32 Releases Wiki Activity
a8aa94062b
django/docs
History
Natalia a8aa94062b [4.2.x] Refs #15578 -- Made cosmetic edits to fixtures docs. 
Backport of b412e5645a from main
2023-10-30 10:33:40 -03:00
..
_ext
_theme
faq
howto [4.2.x] Fixed typo in docs/howto/custom-file-storage.txt. 2023-09-16 07:40:17 +02:00
internals [4.2.x] Corrected note about using accents in writing documentation contributing guide. 2023-10-21 09:40:21 +02:00
intro
man [4.2.x] Updated man page for Django 4.2 final. 2023-04-03 08:56:48 +02:00
misc Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
ref [4.2.x] Fixed typos in docs/ref/models/expressions.txt. 2023-10-28 14:22:30 +02:00
releases [4.2.x] Fixed #34932 -- Restored varchar_pattern_ops/text_pattern_ops index creation when deterministic collaction is set. 2023-10-30 11:14:08 +01:00
topics [4.2.x] Refs #15578 -- Made cosmetic edits to fixtures docs. 2023-10-30 10:33:40 -03:00
conf.py
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
make.bat
Makefile [4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:34:28 +01:00
README.rst
requirements.txt [4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:34:28 +01:00
spelling_wordlist [4.2.x] Fixed #33405, Refs #7177 -- Clarified docs for filter escapejs regarding safe and unsafe usages. 2023-07-03 13:55:31 +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.

.. _ReST: https://docutils.sourceforge.io/rst.html
.. _Sphinx: https://www.sphinx-doc.org/