Django/django
11
0
Fork 0
Code Pull Requests Projects Releases Activity
django/docs
History
Someoneece 6c9c823e7a Renamed docs/README to README.rst.
2020-01-09 08:18:44 +01: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 #23433 -- Deprecated django-admin.py entry point in favor of django-admin.
2019-12-06 12:11:44 +01:00
howto
Refs #30767 -- Improved deployment documentation.
2019-12-20 10:42:56 +01:00
internals
Added guidelines for assertIs() usage.
2019-12-30 11:25:18 +01:00
intro
Removed "Don't do that" from docs and error messages.
2020-01-06 13:50:43 +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 #31118 -- Made FileInput to avoid the required attribute when initial data exists.
2020-01-08 09:15:31 +01:00
releases
Fixed #31118 -- Made FileInput to avoid the required attribute when initial data exists.
2020-01-08 09:15:31 +01:00
topics
Clarified that ValueError raised by converter.to_python() means no match unless another URL pattern matches.
2020-01-08 10:55:06 +01:00
conf.py
Bumped version; master is now 3.1 pre-alpha.
2019-09-10 11:54:25 +02: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 typo in docs/index.txt.
2020-01-03 07:53:31 +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.rst
Renamed docs/README to README.rst.
2020-01-09 08:18:44 +01:00
spelling_wordlist
Fixed #31056 -- Allowed disabling async-unsafe check with an environment variable.
2019-12-03 17:29:31 +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) [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] http://sphinx-doc.org/