mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-27 03:25:58 +00:00
Code Issues 30 Releases Wiki Activity
b4563cdd23
django/docs
History
Mohit Singh Sinsniwal b4563cdd23 [4.2.x] Fixed #34579 -- Added Django Forum to contributing guides. 
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>

Backport of 89f10a80d7 from main
2023-05-23 06:00:02 +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 [4.2.x] Fixed #34545 -- Corrected the number of months in installation FAQ. 2023-05-08 08:34:47 +02:00
howto [4.2.x] Updated broken links in docs. 2023-05-17 12:13:40 +02:00
internals [4.2.x] Fixed #34579 -- Added Django Forum to contributing guides. 2023-05-23 06:00:02 +02:00
intro [4.2.x] Fixed #34579 -- Added Django Forum to contributing guides. 2023-05-23 06:00:02 +02:00
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 #34568 -- Made makemigrations --update respect --name option. 2023-05-17 13:15:30 +02:00
releases [4.2.x] Fixed references to django.core.cache in docs. 2023-05-22 14:02:28 +02:00
topics [4.2.x] Fixed references to django.core.cache in docs. 2023-05-22 14:02:28 +02:00
conf.py [4.2.x] Used extlinks for PyPI links. 2023-04-17 07:44:29 +02:00
contents.txt
glossary.txt
index.txt [4.2.x] Added Django Forum to mailing lists page. 2023-03-24 08:58:45 +01:00
make.bat [4.2.x] Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:34:28 +01:00
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 #34146 -- Added 3rd-party lib tutorial step. 2023-02-07 20:22:11 +01: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/