django-admin2/docs
Adam Chainz 1187eb8709 Convert readthedocs links for their .org -> .io migration for hosted projects
As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’:

> Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.

Test Plan: Manually visited all the links I’ve modified.
2016-06-08 04:07:57 +01:00
..
_ext Make django docs intersphinx work 2013-07-06 13:50:21 +02:00
_static Better translation docs 2013-07-06 16:21:44 +02:00
ref Remove deprecated django.conf.urls. patterns from docs 2016-06-07 13:45:16 +02:00
conf.py Convert readthedocs links for their .org -> .io migration for hosted projects 2016-06-08 04:07:57 +01:00
contributing.rst Convert readthedocs links for their .org -> .io migration for hosted projects 2016-06-08 04:07:57 +01:00
design.rst per #240, this adds indexing to the design document 2013-07-16 20:32:46 +02:00
faq.rst Work on contributing and the FAQ 2013-07-21 13:26:03 +02:00
index.rst Fix documentation examples 2016-06-06 11:52:27 +02:00
installation.rst Fix documentation examples 2016-06-06 11:52:27 +02:00
internationalization.rst Reference to gettext docs 2013-07-06 16:38:24 +02:00
make.bat Basic sphinx documentation layout. 2013-05-18 13:00:51 +02:00
Makefile Basic sphinx documentation layout. 2013-05-18 13:00:51 +02:00
README Setting up autodoc for the docs. 2013-05-29 10:44:22 +02:00
tutorial.rst fix typo 2014-06-19 08:59:56 +02:00

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:

* Create a virtualenv and activate it.

* Install all dependencies from requirements.txt inot the virtualenv using
  ``pip install -r requirements.txt`` (this will also install Sphinx).

* In this docs/ directory, type ``make html`` (or ``make.bat html`` on
  Windows) at a shell prompt while the virtualenv is active.

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.pocoo.org/