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:`user-docs`
* :ref:`feature-docs`
* :ref:`about-docs`

Information about development is also available:

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

.. _user-docs:

.. toctree::
   :maxdepth: 2
   :caption: User Documentation

   getting_started
   versions
   builds
   features
   support
   faq


.. _feature-docs:

.. toctree::
   :maxdepth: 2
   :glob:
   :caption: Feature Documentation

   webhooks
   badges
   alternate_domains
   localization
   vcs
   canonical
   single_version
   privacy
   user-defined-redirects
   automatic-redirects
   features/*


.. _dev-docs:

.. toctree::
   :maxdepth: 2
   :caption: Developer Documentation

   install
   contribute
   tests
   architecture
   symlinks
   settings
   i18n
   api

.. _business-docs:

.. toctree::
   :maxdepth: 2
   :caption: Business Documentation

   business/index

.. _custom-docs:

.. toctree::
   :maxdepth: 2
   :caption: Custom Install Documentation

   custom_installs/index

.. _design-docs:

.. toctree::
   :maxdepth: 2
   :caption: Designer Documentation

   design
   theme


.. _about-docs:

.. toctree::
   :maxdepth: 2
   :caption: About Read the Docs

   open-source-philosophy
   sponsors
   talks


.. _ops-docs:

.. toctree::
   :maxdepth: 2
   :caption: Operations Documentation

   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
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			* :ref:`user-docs`
Don't need the space 2014-01-18 14:19:10 +00:00			* :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
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`.. _user-docs:`
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::`
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`:maxdepth: 2`
			`:caption: User Documentation`
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
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`getting_started`
			`versions`
			`builds`
			`features`
			`support`
			`faq`
Rejigger indexing 2014-01-18 14:10:25 +00:00

Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`.. _feature-docs:`
Rejigger indexing 2014-01-18 14:10:25 +00:00
			`.. toctree::`
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`:maxdepth: 2`
			`:glob:`
			`:caption: Feature Documentation`

			`webhooks`
			`badges`
			`alternate_domains`
			`localization`
			`vcs`
			`canonical`
			`single_version`
			`privacy`
			`user-defined-redirects`
			`automatic-redirects`
			`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
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`.. _dev-docs:`
Add business docs to index 2014-11-05 21:44:51 +00:00
			`.. toctree::`
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`:maxdepth: 2`
			`:caption: Developer Documentation`

			`install`
			`contribute`
			`tests`
			`architecture`
			`symlinks`
			`settings`
			`i18n`
			`api`
Add business docs to index 2014-11-05 21:44:51 +00:00
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`.. _business-docs:`
Add business docs to index 2014-11-05 21:44:51 +00:00
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Business Documentation`
Add basic canonical URL docs 2014-01-03 20:48:04 +00:00
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`business/index`
Add about section to main index. 2014-01-18 14:33:50 +00:00
Add custom install to main level 2015-06-01 15:54:04 +00:00			`.. _custom-docs:`

			`.. toctree::`
			`:maxdepth: 2`
			`:caption: Custom Install Documentation`

			`custom_installs/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:`

			`.. toctree::`
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`:maxdepth: 2`
			`:caption: Designer Documentation`
Rejigger indexing 2014-01-18 14:10:25 +00:00
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`design`
			`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
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`.. _about-docs:`
Add about section to main index. 2014-01-18 14:33:50 +00:00
			`.. toctree::`
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`:maxdepth: 2`
			`:caption: About Read the Docs`
Add about section to main index. 2014-01-18 14:33:50 +00:00
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`open-source-philosophy`
			`sponsors`
			`talks`
Add about section to main index. 2014-01-18 14:33:50 +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			`.. toctree::`
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`:maxdepth: 2`
			`:caption: Operations Documentation`
Added some basic operations documentation. 2011-10-10 02:33:56 +00:00
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`rtfd`