django1/docs
Adam Johnson 00ff7a44de
Fixed links in Getting Help FAQ.
Follow up to 6ef4c8aa9f,
2020-03-30 07:44:39 +02:00
..
_ext Fixed #31025 -- Fixed highlightlinenothreshold deprecation warning on Sphinx 1.8+. 2019-11-25 10:33:33 +01:00
_theme Fixed #31080 -- Removed redundant type="text/javascript" attribute from <script> tags. 2019-12-11 09:49:54 +01:00
faq Fixed links in Getting Help FAQ. 2020-03-30 07:44:39 +02:00
howto Improved sessions notes in deployment checklist. 2020-03-25 12:04:52 +01:00
internals Added link to contributing docs in deprecation policy. 2020-03-24 08:50:10 +01:00
intro Fixed #31385 -- Improved wording in tutorial 1. 2020-03-24 06:30:34 +01:00
man Updated man page for 3.0 alpha release. 2019-09-10 10:10:50 +02:00
misc Expanded API stability docs to include our policy of continual improvement. 2019-11-18 20:37:46 +01:00
ref Fixed #31400 -- Doc'd the expected type of CONN_MAX_AGE database option. 2020-03-27 06:32:42 +01:00
releases Fixed #31402 -- Added migrate --check option. 2020-03-26 20:12:39 +01:00
topics Clarified async documentation. 2020-03-26 16:46:24 +01: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 Fixed #28290 -- Enabled Sphinx auto-label generation for title and section headers. 2020-01-29 14:34:14 +01:00
contents.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
glossary.txt Fixed #26020 -- Normalized header stylings in docs. 2016-01-22 12:12:17 -05:00
index.txt Rewrote Get Help FAQ. 2020-03-26 09:44:00 +01:00
make.bat
spelling_wordlist Clarified async documentation. 2020-03-26 16:46:24 +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/