readthedocs.org/docs/index.rst

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

`Read the Docs`_ hosts documentation for the open source community.
We support Sphinx_ docs written with reStructuredText_ and Markdown_ docs written with Mkdocs_.
We pull your code from your Subversion_, Bazaar_, Git_, and Mercurial_ repositories.
Then we build documentation and host it for you.
Think of it as *Continuous Documentation*.

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
.. _Markdown: http://daringfireball.net/projects/markdown/syntax
.. _Mkdocs: http://www.mkdocs.org/
.. _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 main documentation for the site is organized into a couple sections:

* :ref:`site-docs`
* :ref:`feature-docs`
* :ref:`about-docs`

Information about development is also available:

* :ref:`dev-docs`
* :ref:`design-docs`
* :ref:`ops-docs`

.. _site-docs:

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

.. toctree::
    :maxdepth: 2

    getting_started
    versions
    builds
    features
    support
    faq

.. _feature-docs:

Features
~~~~~~~~

.. toctree::
    :maxdepth: 2
    :glob:

    webhooks
    badges
    alternate_domains
    localization
    vcs
    canonical
    redirects
    single_version
    privacy
    features/*

.. _business-docs:

Business Documentation
----------------------

.. toctree::
    :maxdepth: 2

   business/index

.. _dev-docs:

Developer Documentation
-----------------------

.. toctree::
    :maxdepth: 2

    install
    contribute
    tests
    architecture
    symlinks
    settings
    i18n
    api
    api/index

.. _design-docs:

Designer Documentation
----------------------

.. toctree::
    :maxdepth: 2

    design
    theme

.. _about-docs:

About Read the Docs
-------------------

.. toctree::
    :maxdepth: 2

    open-source-philosophy
    sponsors
    talks


.. Things that need more love before getting upgraded to the above list.

.. _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.
Clean up docs and add mkdocs stuff 2014-10-14 19:16:03 +00:00			`We support Sphinx_ docs written with reStructuredText_ and Markdown_ docs written with Mkdocs_.`
			`We pull your code from your Subversion_, Bazaar_, Git_, and Mercurial_ repositories.`
			`Then we build documentation and host it for you.`
			`Think of it as Continuous Documentation.`

Reworked index, added getting_started 2011-01-11 03:09:03 +00:00			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`
Clean up docs and add mkdocs stuff 2014-10-14 19:16:03 +00:00			`.. _Markdown: http://daringfireball.net/projects/markdown/syntax`
			`.. _Mkdocs: http://www.mkdocs.org/`
Fix doc foul. 2011-04-03 03:46:00 +00:00			`.. _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
Small doc index changes 2014-04-14 14:19:41 +00:00			`The main documentation for the site is organized into a couple sections:`
Rejigger indexing 2014-01-18 14:10:25 +00:00
Don't need the space 2014-01-18 14:19:10 +00:00			* :ref:`site-docs`
			* :ref:`feature-docs`
Add about section to main index. 2014-01-18 14:33:50 +00:00			* :ref:`about-docs`

Clean up doc wording 2014-08-25 23:56:02 +00:00			`Information about development is also available:`
Small doc index changes 2014-04-14 14:19:41 +00:00
			* :ref:`dev-docs`
			* :ref:`design-docs`
			* :ref:`ops-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`
Move versions to user docs 2014-10-19 20:51:50 +00:00			`versions`
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`

			`.. _feature-docs:`

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

			`.. toctree::`
			`:maxdepth: 2`
Add basic docs on embedded content 2015-04-07 01:49:04 +00:00			`:glob:`
Rejigger indexing 2014-01-18 14:10:25 +00:00
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`
Add badges to index 2014-08-15 19:31:16 +00:00			`badges`
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`
			`single_version`
Rejigger index order 2013-12-16 22:54:46 +00:00			`privacy`
Add basic docs on embedded content 2015-04-07 01:49:04 +00:00			`features/*`
Add designer doc as a top-level 2012-12-10 18:57:33 +00:00
Add business docs to index 2014-11-05 21:44:51 +00:00			`.. _business-docs:`

			`Business Documentation`
			`----------------------`

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

			`business/index`

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`
			`-----------------------`
Add about section to main index. 2014-01-18 14:33:50 +00:00
Added a couple of the interesting settings to the documentation. 2011-04-02 22:04:03 +00:00			`.. toctree::`
			`:maxdepth: 2`

Reworked index, added getting_started 2011-01-11 03:09:03 +00:00			`install`
Added a stub contributing doc. 2011-09-19 02:33:15 +00:00			`contribute`
Add about section to main index. 2014-01-18 14:33:50 +00:00			`tests`
Add architecture to the index 2011-06-18 20:08:43 +00:00			`architecture`
Add about section to main index. 2014-01-18 14:33:50 +00:00			`symlinks`
Added a couple of the interesting settings to the documentation. 2011-04-02 22:04:03 +00:00			`settings`
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`
			`----------------------`
Add about section to main index. 2014-01-18 14:33:50 +00:00
Rejigger indexing 2014-01-18 14:10:25 +00:00			`.. 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 about section to main index. 2014-01-18 14:33:50 +00:00			`.. _about-docs:`

			`About Read the Docs`
			`-------------------`

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

Add OSS Philosophy Support document 2014-11-10 19:58:09 +00:00			`open-source-philosophy`
Add about section to main index. 2014-01-18 14:33:50 +00:00			`sponsors`
			`talks`


			`.. Things that need more love before getting upgraded to the above list.`
Rejigger indexing 2014-01-18 14:10:25 +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`
			`------------------------`
Add about section to main index. 2014-01-18 14:33:50 +00:00
Added some basic operations documentation. 2011-10-10 02:33:56 +00:00			`.. toctree::`
			`:maxdepth: 2`

Remove outdated todo page 2014-01-18 14:39:35 +00:00			`rtfd`