Home Explore Help
Sign In
CityApper
/
django
mirror of https://github.com/django/django
2
0
Fork 0
Files Issues 0 Wiki
Tree: 216eb63883
Branches Tags
django
/
docs
Jesper Olsson 216eb63883 Fixed #34409 -- Doc'd limitation of dictfetchall() and namedtuplefetchall() examples. 2 years ago
..
_ext 7119f40c98 Refs #33476 -- Refactored code to strictly match 88 characters line length. 3 years ago
_theme ac90529cc5 Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2 years ago
faq 14459f80ee Fixed #34140 -- Reformatted code blocks in docs with blacken-docs. 2 years ago
howto b00046d2c2 Doc'd use of asgiref.sync adapters with sensitive variables. 2 years ago
internals 78da5ca0c1 Reverted "Fixed #33213 -- Doc'd testing code coverage in parallel and used it." 2 years ago
intro 868e2fcdda Fixed #32539 -- Added toggleable facet filters to ModelAdmin. 2 years ago
man 9409312eef Updated man page for Django 4.2 alpha. 2 years ago
misc 1024b5e74a Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 3 years ago
ref a2eaea8f22 Fixed #34388 -- Allowed using choice enumeration types directly on model and form fields. 2 years ago
releases 23cbed2187 Refs #31949 -- Enabled @sensitive_variables to work with async functions. 2 years ago
topics 216eb63883 Fixed #34409 -- Doc'd limitation of dictfetchall() and namedtuplefetchall() examples. 2 years 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 f9f9215d3e Fixed some typos in comments, docstrings, and tests. 2 years 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 1df7814e4b Refs #34146 -- Fixed typos in tutorial. (#16530) 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 7715c9fef5 Fixed #34146 -- Added 3rd-party lib tutorial step. 2 years 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/