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 `CommonMark`_.
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
.. _CommonMark: http://commonmark.org/
.. _Subversion: http://subversion.tigris.org/
.. _Bazaar: http://bazaar.canonical.com/
.. _Git: http://git-scm.com/
.. _Mercurial: https://www.mercurial-scm.org/
.. _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`

.. _user-docs:

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

   getting_started
   versions
   builds
   features
   support
   faq
   yaml-config
   guides/index
   api
   embed

.. _about-docs:

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

   contribute
   team
   gsoc
   code-of-conduct
   privacy-policy
   advertising/index
   sponsors
   open-source-philosophy
   story
   abandoned-projects
   dmca/index

.. _feature-docs:

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

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


.. _dev-docs:

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

   changelog
   install
   architecture
   tests
   docs
   development/standards
   development/buildenvironments
   symlinks
   settings
   i18n
   issue-labels
   security
   api/index

.. _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 <https://sphinx-rtd-theme.readthedocs.io/en/latest/>
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.
Update instructions for Sphinx & markdown support 2015-06-25 19:13:57 +00:00			We support Sphinx_ docs written with reStructuredText_ and `CommonMark`_.
Clean up docs and add mkdocs stuff 2014-10-14 19:16:03 +00:00			`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.`

Add some unloved documents to index.rst 2017-01-05 19:41:29 +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`
Update instructions for Sphinx & markdown support 2015-06-25 19:13:57 +00:00			`.. _CommonMark: http://commonmark.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/`
Update Mercurial homepage URL 2017-02-28 11:36:03 +00:00			`.. _Mercurial: https://www.mercurial-scm.org/`
Add some unloved documents to index.rst 2017-01-05 19:41:29 +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`
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`
Add initial yaml config docs 2015-12-11 19:18:17 +00:00			`yaml-config`
Add guides to TOC 2016-04-28 17:37:46 +00:00			`guides/index`
Refer to public API from user documentation 2017-01-05 19:26:25 +00:00			`api`
Add some unloved documents to index.rst 2017-01-05 19:41:29 +00:00			`embed`
Rejigger indexing 2014-01-18 14:10:25 +00:00
Add initial stab at a basic ethical advertising page (#2391) * Add initial stab at a basic ethical advertising page Still needs a lot of work and thought. * bit more manifestoy :) * Fix link to idlewords * Add basic styles to form * Bit more form updates * Remove bit in the wrong PR * Remove more spurious code * Final cleanup * Add ethical ads to index * Move contribute doc higher * More about content * Small edits * More copy tweaks * Remove a bit of hubris * Stop calling our thing a product * More wording fixes 2016-08-31 16:49:34 +00:00			`.. _about-docs:`

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

			`contribute`
			`team`
Add gsoc to toc 2018-02-15 07:40:59 +00:00			`gsoc`
Move COC to docs and link it 2017-03-02 23:09:23 +00:00			`code-of-conduct`
First draft of privacy policy 2018-04-20 04:48:57 +00:00			`privacy-policy`
Add a page detailing ad blocking - Creates a good page for the ad block nag to link to - Document about going ad-free - Some advertisers have asked about this - Stats on ad blocking are interesting - we should publish ours 2018-06-14 22:29:07 +00:00			`advertising/index`
Add initial stab at a basic ethical advertising page (#2391) * Add initial stab at a basic ethical advertising page Still needs a lot of work and thought. * bit more manifestoy :) * Fix link to idlewords * Add basic styles to form * Bit more form updates * Remove bit in the wrong PR * Remove more spurious code * Final cleanup * Add ethical ads to index * Move contribute doc higher * More about content * Small edits * More copy tweaks * Remove a bit of hubris * Stop calling our thing a product * More wording fixes 2016-08-31 16:49:34 +00:00			`sponsors`
			`open-source-philosophy`
Add some unloved documents to index.rst 2017-01-05 19:41:29 +00:00			`story`
Add abandoned to TOC 2017-12-08 14:56:29 +00:00			`abandoned-projects`
Add doc on DMCA takedown process (#2608) * Add doc on DMCA takedown process This is an explicit procedure for handling takedown requests. This idea is modeled after GitHub's procedure: * https://github.com/github/dmca * https://help.github.com/articles/dmca-takedown-policy/ * Add link to github's DMCA takedown process 2017-01-25 21:07:06 +00:00			`dmca/index`
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`
Add proper subproject page 2017-01-31 22:18:19 +00:00			`subprojects`
Add conda to doc index 2015-11-30 22:37:12 +00:00			`conda`
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`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`

Added a changelog file to the docs 2015-07-23 18:31:18 +00:00			`changelog`
Rearrange development docs ToC This is to make architecture the top link after changelog and installation instructions. Also moves API to the bottom, because it stands out of the reading flow, which is: - see if the development thing you think about is already done - launch installation if you're going to fix anything - (or) read about archtecture - about testing, probably installation is ready - how to sync docs - standards, etc. - components (should be linked from archtecture) - everything else - leave API pages open 2017-11-10 12:52:11 +00:00			`install`
			`architecture`
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`tests`
Add a docs page 2016-11-30 22:35:38 +00:00			`docs`
Add docs, move standards due to naming 2015-08-08 00:13:17 +00:00			`development/standards`
			`development/buildenvironments`
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`symlinks`
			`settings`
			`i18n`
Add overview of issue labels to docs 2015-07-24 10:31:39 +00:00			`issue-labels`
Update RTD security docs 2018-02-19 23:46:24 +00:00			`security`
Rearrange development docs ToC This is to make architecture the top link after changelog and installation instructions. Also moves API to the bottom, because it stands out of the reading flow, which is: - see if the development thing you think about is already done - launch installation if you're going to fix anything - (or) read about archtecture - about testing, probably installation is ready - how to sync docs - standards, etc. - components (should be linked from archtecture) - everything else - leave API pages open 2017-11-10 12:52:11 +00:00			`api/index`
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`
Point theme link to new theme docs 2017-12-21 21:33:18 +00:00			`Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>`
Rejigger indexing 2014-01-18 14:10:25 +00:00