p31829507
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
django/docs
History
JiriKr cfe563ffaf Fixed #34446 -- Removed unneeded and incorrect example in coding style docs. 2023-03-30 11:06:52 +02:00
..
_ext Refs #33476 -- Refactored code to strictly match 88 characters line length. 2022-02-07 20:37:05 +01:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Fixed #34140 -- Reformatted code blocks in docs with blacken-docs. 2023-03-01 13:03:56 +01:00
howto Reverted "Refs #31949 -- Enabled @sensitive_variables to work with async functions." 2023-03-30 10:22:23 +02:00
internals Fixed #34446 -- Removed unneeded and incorrect example in coding style docs. 2023-03-30 11:06:52 +02:00
intro Fixed #32539 -- Added toggleable facet filters to ModelAdmin. 2023-03-03 20:24:57 +01:00
man Updated man page for Django 4.2 alpha. 2023-01-17 08:51:17 +01:00
misc Fixed 32956 -- Lowercased spelling of "web" and "web framework" where appropriate. 2021-07-29 06:24:12 +02:00
ref Fixed typos in docs/ref/forms/renderers.txt. 2023-03-24 12:54:47 +01:00
releases Reverted "Refs #31949 -- Enabled @sensitive_variables to work with async functions." 2023-03-30 10:22:23 +02:00
topics Fixed #34077 -- Added form field rendering. 2023-03-24 10:16:30 +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 Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py Fixed some typos in comments, docstrings, and tests. 2023-03-20 08:07:23 +01: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
requirements.txt Refs #34140 -- Added configurations to run blacken-docs linter and adjusted docs. 2023-03-01 13:02:57 +01:00
spelling_wordlist Fixed #34146 -- Added 3rd-party lib tutorial step. 2023-02-07 15:26:37 +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/