readthedocs.org/docs/index.rst

Welcome to Read The Docs
========================

`Read the Docs`_ hosts documentation for the open source community.
It supports Sphinx_ docs written with reStructuredText_, and can pull
from your Subversion_, Bazaar_, Git_, and Mercurial_ repositories.
The code is open source, and `available on github`_.

.. _Read the docs: http://readthedocs.org/
.. _Sphinx: http://sphinx.pocoo.org/
.. _reStructuredText: http://sphinx.pocoo.org/rest.html
.. _Subversion: http://subversion.tigris.org/
.. _Bazaar: http://bazaar.canonical.com/
.. _Git: http://git-scm.com/
.. _Mercurial: http://mercurial.selenic.com/
.. _available on github: http://github.com/rtfd/readthedocs.org

The documentation for the site is organized into a few different sections below:

* :ref:`site-docs`
* :ref:`feature-docs`
* :ref:`dev-docs`
* :ref:`design-docs`

.. _site-docs:

User Documentation
------------------

.. toctree::
    :maxdepth: 2

    getting_started
    builds
    features
    support
    faq
    sponsors
    talks

.. _feature-docs:

Features
~~~~~~~~

.. toctree::
    :maxdepth: 2

    webhooks
    alternate_domains
    localization
    vcs
    canonical
    redirects
    versions
    single_version
    privacy

.. _dev-docs:

Developer Documentation
-----------------------
.. toctree::
    :maxdepth: 2

    install
    symlinks
    todo
    contribute
    architecture
    settings
    tests
    i18n
    api
    api/index

.. _design-docs:

Designer Documentation
----------------------
.. toctree::
    :maxdepth: 2

    design
    theme


.. _custom-docs:

Custom install Documentation
----------------------------
.. toctree::
    :maxdepth: 3

    custom_installs/index
    settings

.. _ops-docs:

Operations Documentation
------------------------
.. toctree::
    :maxdepth: 2

    rtfd
Reworked index, added getting_started 2011-01-11 03:09:03 +00:00			`Welcome to Read The Docs`
			`========================`
Initial commit of our docs. 2010-08-14 05:07:13 +00:00
Reworked index, added getting_started 2011-01-11 03:09:03 +00:00			`Read the Docs`_ hosts documentation for the open source community.
			`It supports Sphinx_ docs written with reStructuredText_, and can pull`
			`from your Subversion_, Bazaar_, Git_, and Mercurial_ repositories.`
			The code is open source, and `available on github`_.
Fix VCS bits in docs. 2010-09-08 00:20:43 +00:00
Reworked index, added getting_started 2011-01-11 03:09:03 +00:00			`.. _Read the docs: http://readthedocs.org/`
Fix doc foul. 2011-04-03 03:46:00 +00:00			`.. _Sphinx: http://sphinx.pocoo.org/`
			`.. _reStructuredText: http://sphinx.pocoo.org/rest.html`
			`.. _Subversion: http://subversion.tigris.org/`
			`.. _Bazaar: http://bazaar.canonical.com/`
			`.. _Git: http://git-scm.com/`
			`.. _Mercurial: http://mercurial.selenic.com/`
Reworked index, added getting_started 2011-01-11 03:09:03 +00:00			`.. _available on github: http://github.com/rtfd/readthedocs.org`
put on your copy cap 2010-08-16 04:01:19 +00:00
Rejigger indexing 2014-01-18 14:10:25 +00:00			`The documentation for the site is organized into a few different sections below:`

Don't need the space 2014-01-18 14:19:10 +00:00			* :ref:`site-docs`
			* :ref:`feature-docs`
			* :ref:`dev-docs`
			* :ref:`design-docs`
Added the ability to read the intersphinx files into redis for the projects. Thanks again to Jacob for the ideas and some of the codes. 2011-04-10 01:45:04 +00:00
Add basic canonical URL docs 2014-01-03 20:48:04 +00:00			`.. _site-docs:`
put on your copy cap 2010-08-16 04:01:19 +00:00
Rejigger indexing 2014-01-18 14:10:25 +00:00			`User Documentation`
Added a couple of the interesting settings to the documentation. 2011-04-02 22:04:03 +00:00			`------------------`

Initial commit of our docs. 2010-08-14 05:07:13 +00:00			`.. toctree::`
Added stub .rst files for most of the API; modified conf.py so Sphinx can setup the Django environment before importing; cleaned up and formatted existing .rst docs a little 2010-09-03 02:27:25 +00:00			`:maxdepth: 2`

Reworked index, added getting_started 2011-01-11 03:09:03 +00:00			`getting_started`
Rejigger indexing 2014-01-18 14:10:25 +00:00			`builds`
			`features`
rejigger doc order. 2011-04-03 00:54:39 +00:00			`support`
Rejigger indexing 2014-01-18 14:10:25 +00:00			`faq`
			`sponsors`
			`talks`

			`.. _feature-docs:`

			`Features`
			`~~~~~~~~`

			`.. toctree::`
			`:maxdepth: 2`

Added stub .rst files for most of the API; modified conf.py so Sphinx can setup the Django environment before importing; cleaned up and formatted existing .rst docs a little 2010-09-03 02:27:25 +00:00			`webhooks`
Added docs about CNAME support/subdomains. 2011-01-11 04:37:24 +00:00			`alternate_domains`
More rejiggers 2014-01-18 14:12:17 +00:00			`localization`
Add vcs page to feature list 2014-01-18 14:16:24 +00:00			`vcs`
Add basic canonical URL docs 2014-01-03 20:48:04 +00:00			`canonical`
More rejiggers 2014-01-18 14:12:17 +00:00			`redirects`
More doc cleanup 2014-01-18 14:17:55 +00:00			`versions`
More rejiggers 2014-01-18 14:12:17 +00:00			`single_version`
Rejigger index order 2013-12-16 22:54:46 +00:00			`privacy`
Add designer doc as a top-level 2012-12-10 18:57:33 +00:00
Add basic canonical URL docs 2014-01-03 20:48:04 +00:00			`.. _dev-docs:`

Added a couple of the interesting settings to the documentation. 2011-04-02 22:04:03 +00:00			`Developer Documentation`
			`-----------------------`
			`.. toctree::`
			`:maxdepth: 2`

Reworked index, added getting_started 2011-01-11 03:09:03 +00:00			`install`
Rejigger docs 2014-01-06 17:57:06 +00:00			`symlinks`
Commit a todo list with a braindump from my Pycon poster. 2012-03-11 20:43:17 +00:00			`todo`
Added a stub contributing doc. 2011-09-19 02:33:15 +00:00			`contribute`
Add architecture to the index 2011-06-18 20:08:43 +00:00			`architecture`
Added a couple of the interesting settings to the documentation. 2011-04-02 22:04:03 +00:00			`settings`
Added basic blurb about testing. 2011-04-03 00:30:45 +00:00			`tests`
Added i18n documentation 2012-10-03 16:18:34 +00:00			`i18n`
Added API docs to the toctree. 2011-03-15 06:23:38 +00:00			`api`
Added stub .rst files for most of the API; modified conf.py so Sphinx can setup the Django environment before importing; cleaned up and formatted existing .rst docs a little 2010-09-03 02:27:25 +00:00			`api/index`
Added some basic operations documentation. 2011-10-10 02:33:56 +00:00
Rejigger indexing 2014-01-18 14:10:25 +00:00			`.. _design-docs:`

			`Designer Documentation`
			`----------------------`
			`.. toctree::`
			`:maxdepth: 2`

			`design`
Move theme to designer docs 2014-01-18 14:14:48 +00:00			`theme`
Rejigger indexing 2014-01-18 14:10:25 +00:00

Add basic canonical URL docs 2014-01-03 20:48:04 +00:00			`.. _custom-docs:`

Add basic docs about custom installs. 2013-01-29 23:07:38 +00:00			`Custom install Documentation`
			`----------------------------`
			`.. toctree::`
			`:maxdepth: 3`

			`custom_installs/index`
Add settings to custo install bits too 2014-01-18 14:13:39 +00:00			`settings`
Add basic docs about custom installs. 2013-01-29 23:07:38 +00:00
Add basic canonical URL docs 2014-01-03 20:48:04 +00:00			`.. _ops-docs:`

Added some basic operations documentation. 2011-10-10 02:33:56 +00:00			`Operations Documentation`
			`------------------------`
			`.. toctree::`
			`:maxdepth: 2`

			`rtfd`