mirrors
/
django
mirror of https://github.com/django/django.git
1
0
Fork 0
Code Issues 24 Releases Wiki Activity
django/docs
History
Mariusz Felisiak d9cee3f5f2 Fixed docs header underlines in security archive. 2021-06-02 12:16:38 +02:00
..
_ext Made default_role_error use logger. 2020-06-03 11:42:42 +02:00
_theme Fixed #16300 -- Improved singlehtml docs formatting with headers CSS. 2020-06-22 21:05:13 +02:00
faq Changed IRC references to Libera.Chat. 2021-05-20 12:23:36 +02:00
howto Refs #32720 -- Updated various links in docs to avoid redirects and use HTTPS. 2021-05-17 09:46:09 +02:00
internals Fixed typo in docs/internals/contributing/writing-code/coding-style.txt. 2021-06-02 08:14:57 +02:00
intro Changed IRC references to Libera.Chat. 2021-05-20 12:23:36 +02:00
man Updated django-admin man page for Django 3.2. 2021-01-14 14:58:28 +01:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref Fixed #32319 -- Added ES module support to ManifestStaticFilesStorage. 2021-05-31 11:09:48 +02:00
releases Fixed docs header underlines in security archive. 2021-06-02 12:16:38 +02:00
topics Refs #32552 -- Added DiscoverRunner.log() to allow customization. 2021-06-01 13:31:44 +02:00
Makefile Fixed docs build with Sphinx 1.6. 2017-05-24 09:13:26 -04:00
README.rst Refs #25778 -- Updated sphinx-doc.org links to HTTPS. 2020-01-29 06:04:15 +01:00
conf.py Changed IRC references to Libera.Chat. 2021-05-20 12:23:36 +02:00
contents.txt
…
glossary.txt
…
index.txt Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02:00
make.bat Added spelling option to make.bat. 2021-04-30 14:04:22 +02:00
requirements.txt Used GitHub actions for docs tests. 2021-02-26 22:12:25 +01:00
spelling_wordlist Changed IRC references to Libera.Chat. 2021-05-20 12:23:36 +02: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/