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 two different sections below. One is for users of readthedocs.org, that is the first section. The next section is for users of the code that powers the site. All of the RTD code is open source, so you can run your own instance. Presumably in an internal install inside your company, or something.


Site Documentation
------------------

.. toctree::
    :maxdepth: 2

    getting_started
    faq
    support
    features
    webhooks
    alternate_domains
    sponsors
    builds
    talks

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

    install
    todo
    contribute
    architecture
    settings
    tests
    i18n
    api
    api/index

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
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			`The documentation for the site is organized into two different sections below. One is for users of readthedocs.org, that is the first section. The next section is for users of the code that powers the site. All of the RTD code is open source, so you can run your own instance. Presumably in an internal install inside your company, or something.`

put on your copy cap 2010-08-16 04:01:19 +00:00
Added a couple of the interesting settings to the documentation. 2011-04-02 22:04:03 +00:00			`Site Documentation`
			`------------------`

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`
Added a basic faq for now. 2011-09-09 18:05:37 +00:00			`faq`
rejigger doc order. 2011-04-03 00:54:39 +00:00			`support`
Add sponsors to the documentation as well. 2012-03-26 21:27:22 +00:00			`features`
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`
Add sponsors to the documentation as well. 2012-03-26 21:27:22 +00:00			`sponsors`
			`builds`
Added a talk section to the docs. 2011-06-21 10:23:49 +00:00			`talks`
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`
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
			`Operations Documentation`
			`------------------------`
			`.. toctree::`
			`:maxdepth: 2`

			`rtfd`