Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Adam Johnson c740a994fa [3.0.x] Improved docs on migration reversibility. 
- Clarify reversibility for RunSQL and RunPython operations.
- Add example for migrate with irreversible migration.

Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
Backport of b15b3706fec8ef59577ac47118ee0c62132a03a6 from master
2020-03-25 14:39:17 +01:00
..
_ext
[3.0.x] Fixed #31025 -- Fixed highlightlinenothreshold deprecation warning on Sphinx 1.8+.
2019-11-25 10:34:21 +01:00
_theme
Refs #20910 -- Replaced snippet directive with code-block.
2018-09-10 13:00:34 -04:00
faq
[3.0.x] Fixed #31018 -- Removed django-nonrel in NoSQL databases FAQ.
2019-11-27 07:37:32 +01:00
howto
[3.0.x] Improved sessions notes in deployment checklist.
2020-03-25 12:05:36 +01:00
internals
[3.0.x] Added link to contributing docs in deprecation policy.
2020-03-24 08:50:50 +01:00
intro
[3.0.x] Fixed #31385 -- Improved wording in tutorial 1.
2020-03-24 07:12:59 +01:00
man
[3.0.x] Updated man page for Django 3.0 release candidate 1.
2019-11-18 09:27:41 +01:00
misc
[3.0.x] Expanded API stability docs to include our policy of continual improvement.
2019-11-18 21:39:30 +01:00
ref
[3.0.x] Improved docs on migration reversibility.
2020-03-25 14:39:17 +01:00
releases
[3.0.x] Fixed #31377 -- Disabled grouping by aliases on QuerySet.values()/values_list() when they collide with field names.
2020-03-25 09:49:51 +01:00
topics
[3.0.x] Improved docs on migration reversibility.
2020-03-25 14:39:17 +01:00
conf.py
[3.0.x] Fixed #31212 -- Updated psycopg links to HTTPS and new location.
2020-01-29 06:53:43 +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
[3.0.x] Fixed typo in docs/index.txt.
2020-01-03 07:54:25 +01:00
make.bat
Fixed #19516 - Fixed remaining broken links.
2013-01-02 18:32:57 -05:00
Makefile
Fixed docs build with Sphinx 1.6.
2017-05-24 09:13:26 -04:00
README
[3.0.x] Refs #25778 -- Updated sphinx-doc.org links to HTTPS.
2020-01-29 06:06:23 +01:00
spelling_wordlist
[3.0.x] Refs #31224 -- Doc'd async adapter functions.
2020-03-13 07:37:30 +01:00

README 

The documentation in this tree is in plain text files and can be viewed using
any text file viewer.

It uses ReST (reStructuredText) [1], and the Sphinx documentation system [2].
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.

[1] http://docutils.sourceforge.net/rst.html
[2] https://www.sphinx-doc.org/