mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-22 09:05:43 +00:00
Code Issues 25 Releases Wiki Activity
7e759d9af7
django/docs
History
Maria Hynes 7e759d9af7 Fixed #17430 -- Documented access to the Django admin when using a custom auth backend.
2024-11-14 10:29:32 +01: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 Fixed a typo in docs/howto/static-files/deployment.txt. 2024-11-14 09:46:34 +01:00
internals Refs #32365 -- Removed pytz from list of test dependencies in unit test docs. 2024-11-11 12:24:21 +01:00
intro Added missing lang attributes to html elements in docs. 2024-10-30 14:02:30 +01: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 Fixed #17905 -- Restricted access to model pages in admindocs. 2024-11-11 16:56:03 +01:00
releases Fixed #17905 -- Restricted access to model pages in admindocs. 2024-11-11 16:56:03 +01:00
topics Fixed #17430 -- Documented access to the Django admin when using a custom auth backend. 2024-11-14 10:29:32 +01: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/