mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2024-12-27 11:35:53 +00:00
Code Issues 30 Releases Wiki Activity
a4a0f66570
django/docs
History
Mark Walker a4a0f66570 [5.0.x] Improved structure of Contributing Guide start page. 
Backport of 6ab0f8ae52 from main
2023-11-30 09:32:34 +01:00
..
_ext Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+. 2023-08-03 08:01:06 +02:00
_theme
faq [5.0.x] Added VoiceOver iOS and macOS separately in admin FAQ. 2023-11-21 05:46:49 +01:00
howto [5.0.x] Refs #34118 -- Doc'd Python 3.12 compatibility in Django 4.2.x. 2023-11-19 16:33:01 +01:00
internals [5.0.x] Improved structure of Contributing Guide start page. 2023-11-30 09:32:34 +01:00
intro [5.0.x] Refs #34118 -- Doc'd Python 3.12 compatibility in Django 4.2.x. 2023-11-19 16:33:01 +01:00
man [5.0.x] Updated man page for Django 5.0 rc1. 2023-11-20 08:46:20 -03:00
misc
ref [5.0.x] Updated conditions to retrieve primary keys in bulk_create() docs. 2023-11-29 13:00:32 +01:00
releases [5.0.x] Refs #34380 -- Added FORMS_URLFIELD_ASSUME_HTTPS transitional setting. 2023-11-28 20:08:10 +01:00
topics [5.0.x] Removed obsolete warnings about asgiref.sync adapters with sensitive variables. 2023-11-17 12:09:58 +01:00
conf.py [5.0.x] Bumped django_next_version in docs config. 2023-09-18 11:28:22 -03:00
contents.txt
glossary.txt
index.txt Added Django Forum to mailing lists page. 2023-03-24 08:32:17 +01:00
make.bat Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
Makefile Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
README.rst
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist [5.0.x] Doc'd support for assistive technologies in the admin. 2023-11-17 11:20:54 +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/