1
0
mirror of https://github.com/django/django.git synced 2024-12-31 21:46:05 +00:00
django/docs
GabbyPrecious ead9085f08 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>
2021-03-03 15:34:06 +01:00
..
_ext
_theme
faq Added stub release notes for 4.0. 2021-01-14 17:50:04 +01:00
howto Updated links to DEPs. 2021-02-25 17:22:07 +01:00
internals Refs #32412 -- Adjusted Contributing Guide start page. 2021-03-03 15:34:06 +01:00
intro Refs #30944 -- Added pyproject.toml in reusable apps docs. 2021-02-11 12:44:38 +01:00
man Updated django-admin man page for Django 3.2. 2021-01-14 14:58:28 +01:00
misc
ref Fixed #27854 -- Added system check for nonexistent directories in STATICFILES_DIRS setting. 2021-03-03 11:27:08 +01:00
releases Fixed #32493 -- Removed redundant never_cache uses from admin views. 2021-03-03 09:13:07 +01:00
topics Fixed #32271 -- Improved consistency of docs CBV examples. 2021-03-02 08:33:05 +01:00
conf.py Used GitHub actions for docs tests. 2021-02-26 22:12:25 +01:00
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
requirements.txt Used GitHub actions for docs tests. 2021-02-26 22:12:25 +01:00
spelling_wordlist Fixed #32018 -- Extracted admin colors into CSS variables. 2021-01-07 10:07:19 +01:00

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/