django/docs
GabbyPrecious cafabd0859 [3.2.x] Refs #32412 -- Adjusted Contributing Guide start page.
* Added headers emphasising Work on the framework vs Join the community
  sections, to raise the visibility of the community section.
* Added callouts to three main code/docs/translations areas, linking to
  respective start pages.
* Moved some Writing code specific content from the start page to the
  Writing code index. This clarifies the start page and adds content to the
  previously empty Writing code index.

Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>

Backport of ead9085f08 from master
2021-03-03 15:41:10 +01: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 Refs #31040 -- Doc'd Python 3.9 compatibility. 2020-10-13 08:35:01 +02:00
howto [3.2.x] Updated links to DEPs. 2021-02-25 17:27:32 +01:00
internals [3.2.x] Refs #32412 -- Adjusted Contributing Guide start page. 2021-03-03 15:41:10 +01:00
intro [3.2.x] Refs #32412 -- Adjusted link from tutorial to reference docs. 2021-02-04 10:37:36 +01: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 [3.2.x] Fixed #32271 -- Improved consistency of docs CBV examples. 2021-03-02 09:01:57 +01:00
releases [3.2.x] Fixed typos in assertQuerysetEqual() docs and 1.6 release notes. 2021-02-26 09:11:57 +01:00
topics [3.2.x] Fixed #32271 -- Improved consistency of docs CBV examples. 2021-03-02 09:01:57 +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 [3.2.x] Added documentation extlink for bugs.python.org. 2021-02-17 14:25:54 +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 Fixed #25712 -- Reorganized templates docs. 2020-04-30 08:12:09 +02:00
make.bat
spelling_wordlist Fixed #32018 -- Extracted admin colors into CSS variables. 2021-01-07 10:07:19 +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/