Home Explore Help
Sign In
CityApper
/
django
mirror of https://github.com/django/django
2
0
Fork 0
Files Issues 0 Wiki
Tree: d490d009a3
Branches Tags
django
/
docs
Adrienne Franke d490d009a3 [5.0.x] Fixed typo in docs/topics/auth/default.txt. 1 year ago
..
_ext b3e0170ab5 Fixed #34756 -- Fixed docs HTML build on Sphinx 7.1+. 1 year ago
_theme ac90529cc5 Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2 years ago
faq ae35d5178b [5.0.x] Updated examples for 2.0+ release numbering in installation FAQ. 1 year ago
howto f721fb937c [5.0.x] Refs #34118 -- Doc'd Python 3.12 compatibility in Django 4.2.x. 1 year ago
internals a4a0f66570 [5.0.x] Improved structure of Contributing Guide start page. 1 year ago
intro 60bc65eb80 [5.0.x] Fixed tutorial 'background.gif' reference. 1 year ago
man efd6cbfadf [5.0.x] Updated man page for Django 5.0 rc1. 1 year ago
misc 1024b5e74a Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 3 years ago
ref c4a6a8d815 [5.0.x] Updated "Dive Into Python" links. 1 year ago
releases ee78fe390d [5.0.x] Fixed #35127 -- Made Model.full_clean() ignore GeneratedFields. 1 year ago
topics d490d009a3 [5.0.x] Fixed typo in docs/topics/auth/default.txt. 1 year ago
Makefile 6015bab80e Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2 years ago
README.rst 32166a9f7c Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 5 years ago
conf.py fbfa1b669a [5.0.x] Bumped django_next_version in docs config. 1 year ago
contents.txt bca9faae95 Fixed #26020 -- Normalized header stylings in docs. 9 years ago
glossary.txt bca9faae95 Fixed #26020 -- Normalized header stylings in docs. 9 years ago
index.txt d33368b4ab Added Django Forum to mailing lists page. 2 years ago
make.bat 6015bab80e Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2 years ago
requirements.txt 6015bab80e Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2 years ago
spelling_wordlist 0923472aa2 [5.0.x] Doc'd support for assistive technologies in the admin. 1 year ago

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/