mirrors/django
mirrors/django
0
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-11-21 19:09:18 +01:00
Code Issues Releases Wiki Activity
7a1fa20e9b
django/docs
History
mbcodes c973d9ee82 Improved readability of triage workflow image by increasing its size and color contrast.
2024-10-25 10:00:33 +02:00
..
_ext Fixed typo in source file linking Sphinx extension. 2024-07-01 11:32:48 -03:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Refs #34900 -- Doc'd Python 3.13 compatibility. 2024-10-09 09:27:33 +02:00
howto Updated authentication solutions list on using REMOTE_USER how-to. 2024-10-24 09:54:55 +02:00
internals Improved readability of triage workflow image by increasing its size and color contrast. 2024-10-25 10:00:33 +02:00
intro Updated tutorial part count from 7 to 8 in docs/intro/reusable-apps.txt. 2024-10-21 14:20:03 -03:00
man Updated man page for Django 5.1 alpha. 2024-05-22 11:29:45 -03:00
misc Removed mention of designers in DTL design philosophy. 2024-02-01 09:20:11 +01:00
ref Refs #35803 -- Added support for __covers GIS lookup on MySQL. 2024-10-25 07:55:55 +02:00
releases Refs #35803 -- Added support for __covers GIS lookup on MySQL. 2024-10-25 07:55:55 +02:00
topics Fixed #35731 -- Extended db_default docs. 2024-10-23 11:48:30 +02:00
conf.py Fixed docs build on Sphinx 8.1+. 2024-10-11 17:14:02 +02:00
contents.txt
glossary.txt
index.txt Replaced usage of "patch" with more precise terms in faq, howto, and intro docs. 2024-06-09 14:38:04 -03:00
make.bat Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
Makefile Used webbroswer module in docs Makefile. 2024-10-24 10:45:44 +02:00
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Expanded contributor docs on getting feedback from the wider community. 2024-10-16 13:23:19 +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/