django/docs
Mohit Singh Sinsniwal 89f10a80d7 Fixed #34579 -- Added Django Forum to contributing guides.
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-05-22 20:21:18 +02:00
..
_ext Removed unnecessary workarounds for Sphinx < 4.3.0. 2023-05-04 13:55:06 +02:00
_theme Fixed docs build with sphinxcontrib-spelling 7.5.0+. 2022-05-31 11:17:01 +02:00
faq Fixed #34545 -- Corrected the number of months in installation FAQ. 2023-05-08 08:34:23 +02:00
howto Updated broken links in docs. 2023-05-17 12:13:10 +02:00
internals Fixed #34579 -- Added Django Forum to contributing guides. 2023-05-22 20:21:18 +02:00
intro Fixed #34579 -- Added Django Forum to contributing guides. 2023-05-22 20:21:18 +02: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 #34577 -- Added escapeseq template filter. 2023-05-22 09:58:03 +02:00
releases Fixed references to django.core.cache in docs. 2023-05-22 14:02:01 +02:00
topics Fixed references to django.core.cache in docs. 2023-05-22 14:02:01 +02: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 Used extlinks for PyPI links. 2023-04-17 06:55:32 +02: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/