Home Explore Help
Sign In
CityApper
/
django
mirror of https://github.com/django/django
2
0
Fork 0
Files Issues 0 Wiki
Tree: 5ec64fa481
Branches Tags
django
/
docs
Smile 5ec64fa481 Corrected curl call in working with Git docs. 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 d10e569ea5 Added stub release notes for 4.2. 2 years ago
howto fe6f4bef03 Fixed #26975 -- Clarified how Django looks for fixture files. 2 years ago
internals 5ec64fa481 Corrected curl call in working with Git docs. 2 years ago
intro a16132a9c4 Updated UTC uses to datetime.timezone.utc in docs. 2 years ago
man 5325a6344c Updated man page for Django 4.1 alpha. 2 years ago
misc 1024b5e74a Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 3 years ago
ref 38936f6a0c Fixed typo in docs/ref/models/querysets.txt. 2 years ago
releases 5c2c7277d4 Fixed #34085 -- Made management commands don't use black for non-Python files. 2 years ago
topics d3579ca112 Fixed #25996 -- Revised performance section in URLs topic docs. 2 years ago
Makefile 565ad5ace4 Fixed #33753 -- Fixed docs build on Sphinx 5+. 2 years ago
README.rst 32166a9f7c Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 5 years ago
conf.py ebf25555bb Bumped minimum Sphinx version to 4.5.0. 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 1024b5e74a Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 3 years ago
make.bat 7582d913e7 Added spelling option to make.bat. 3 years ago
requirements.txt 3fb9c74d13 Bumped minimum Sphinx version to 4.5.0 in docs/requirements.txt. 2 years ago
spelling_wordlist 08303f4f06 Added Central Kurdish (Sorani) language. 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/