mirrors/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2025-01-09 18:06:34 +00:00
Code Issues 32 Releases Wiki Activity
3f8979e37b
django/docs
History
Carlton Gibson e48e78738e Corrected typo in advice to new contributors.
2021-02-04 16:00:47 +01:00
..
_ext
_theme
faq
howto Corrected versionadded annotations. 2021-01-19 11:52:47 +01:00
internals Corrected typo in advice to new contributors. 2021-02-04 16:00:47 +01:00
intro Refs #32412 -- Adjusted link from tutorial to reference docs. 2021-02-04 10:33:16 +01:00
man
misc
ref Fixed #32395 -- Allowed capturing stdout of migration signals. 2021-02-04 11:19:49 +01:00
releases Fixed #32395 -- Allowed capturing stdout of migration signals. 2021-02-04 11:19:49 +01:00
topics Modernized custom manager example 2021-01-28 15:59:39 +01:00
conf.py
contents.txt
glossary.txt
index.txt
make.bat
Makefile
README.rst
spelling_wordlist

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/