readthedocs.org/docs/index.rst

Read the Docs: Documentation Simplified
=======================================

`Read the Docs`_ simplifies software documentation
by automating building, versioning, and hosting of your docs for you.
Think of it as *Continuous Documentation*.

Never out of sync
    Whenever you push code to your favorite version control system,
    whether that is Git, Mercurial, Bazaar, or Subversion,
    Read the Docs will automatically build your docs
    so your code and documentation are always up-to-date.

Multiple versions
    Read the Docs can host and build multiple versions of your docs
    so having a 1.0 version of your docs and a 2.0 version
    of your docs is as easy as having a separate branch or tag in your version control system.

Free and open source
    Read the Docs is free and open source and hosts documentation
    for nearly 100,000 large and small open source projects
    in almost every human and computer language.

.. _Read the docs: http://readthedocs.org/


First steps
-----------

Are you new to software documentation
or are you looking to use your existing docs with Read the Docs?
Learn about documentation authoring tools such as Sphinx and MkDocs
to help you create fantastic documentation for your project.

* **Getting started**:
  :doc:`With Sphinx <intro/getting-started-with-sphinx>` |
  :doc:`With MkDocs <intro/getting-started-with-mkdocs>`

* **Importing your existing documentation**:
  :doc:`Import guide <intro/import-guide>`

.. toctree::
   :maxdepth: 2
   :hidden:
   :caption: First Steps

   intro/getting-started-with-sphinx
   intro/getting-started-with-mkdocs
   intro/import-guide


.. _user-docs:

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

   versions
   builds
   features
   connected-accounts
   support
   faq
   config-file/index
   guides/index
   api/index
   embed

.. _feature-docs:

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

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

.. _about-docs:

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

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

.. _dev-docs:

.. toctree::
   :maxdepth: 1
   :caption: Developer Documentation

   changelog
   install
   development/search
   architecture
   tests
   docs
   development/standards
   development/buildenvironments
   symlinks
   settings
   i18n
   issue-labels
   security
   design
   RTD Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>

.. _commercial-docs:

.. toctree::
   :maxdepth: 2
   :caption: Commercial Documentation

   commercial/index

.. _custom-docs:

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

   custom_installs/index
Improve the getting started docs 2018-09-28 22:42:50 +00:00			`Read the Docs: Documentation Simplified`
			`=======================================`
Initial commit of our docs. 2010-08-14 05:07:13 +00:00
Improve the getting started docs 2018-09-28 22:42:50 +00:00			`Read the Docs`_ simplifies software documentation
			`by automating building, versioning, and hosting of your docs for you.`
Clean up docs and add mkdocs stuff 2014-10-14 19:16:03 +00:00			`Think of it as Continuous Documentation.`

Improve the getting started docs 2018-09-28 22:42:50 +00:00			`Never out of sync`
			`Whenever you push code to your favorite version control system,`
			`whether that is Git, Mercurial, Bazaar, or Subversion,`
			`Read the Docs will automatically build your docs`
			`so your code and documentation are always up-to-date.`

			`Multiple versions`
			`Read the Docs can host and build multiple versions of your docs`
			`so having a 1.0 version of your docs and a 2.0 version`
			`of your docs is as easy as having a separate branch or tag in your version control system.`

			`Free and open source`
			`Read the Docs is free and open source and hosts documentation`
			`for nearly 100,000 large and small open source projects`
			`in almost every human and computer language.`
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/`
put on your copy cap 2010-08-16 04:01:19 +00:00
Rejigger indexing 2014-01-18 14:10:25 +00:00
Improve the getting started docs 2018-09-28 22:42:50 +00:00			`First steps`
			`-----------`

			`Are you new to software documentation`
			`or are you looking to use your existing docs with Read the Docs?`
			`Learn about documentation authoring tools such as Sphinx and MkDocs`
			`to help you create fantastic documentation for your project.`

			`* Getting started:`
			:doc:`With Sphinx <intro/getting-started-with-sphinx>` \|
			:doc:`With MkDocs <intro/getting-started-with-mkdocs>`
Add about section to main index. 2014-01-18 14:33:50 +00:00
Improve the getting started docs 2018-09-28 22:42:50 +00:00			`* Importing your existing documentation:`
			:doc:`Import guide <intro/import-guide>`

			`.. toctree::`
			`:maxdepth: 2`
			`:hidden:`
			`:caption: First Steps`
Add about section to main index. 2014-01-18 14:33:50 +00:00
Improve the getting started docs 2018-09-28 22:42:50 +00:00			`intro/getting-started-with-sphinx`
			`intro/getting-started-with-mkdocs`
			`intro/import-guide`
Small doc index changes 2014-04-14 14:19:41 +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
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			`versions`
			`builds`
			`features`
Improve the getting started docs 2018-09-28 22:42:50 +00:00			`connected-accounts`
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`support`
			`faq`
Add docs for v2 2018-07-30 20:15:53 +00:00			`config-file/index`
Add guides to TOC 2016-04-28 17:37:46 +00:00			`guides/index`
Add documentation for APIv2 - This is a pure docs PR, no code changes - Move internal class API to "developer-interface" folder - Move APIv1 into a folder and add APIv2 2018-06-19 21:56:24 +00:00			`api/index`
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
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`
Fix renamed document 2019-02-19 21:17:45 +00:00			`custom_domains`
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`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
Improve the getting started docs 2018-09-28 22:42:50 +00:00			`.. _about-docs:`

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

			`contribute`
Merge branch 'master' into davidfischer/docs-getting-started-improvements 2018-10-02 23:41:14 +00:00			`roadmap`
Improve the getting started docs 2018-09-28 22:42:50 +00:00			`team`
			`gsoc`
			`code-of-conduct`
			`privacy-policy`
			`advertising/index`
			`sponsors`
			`open-source-philosophy`
			`story`
			`abandoned-projects`
			`dmca/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			`.. _dev-docs:`
Add business docs to index 2014-11-05 21:44:51 +00:00
			`.. toctree::`
Improve the getting started docs 2018-09-28 22:42:50 +00:00			`:maxdepth: 1`
Update docs to use Sphinx 1.3 style captions 2015-05-04 22:00:39 +00:00			`: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`
Reapply search upgrade to master. This is a squashed commit of all previous changes. 2018-12-20 14:25:26 +00:00			`development/search`
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			`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`
Improve the getting started docs 2018-09-28 22:42:50 +00:00			`design`
			`RTD Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>`
Add business docs to index 2014-11-05 21:44:51 +00:00
Copy feedback * use commercial instead of business * Custom Domain instead CNAM * paraphrase some sentences * rename alternate_domain.rst to custom_domain.rst 2018-10-03 10:30:55 +00:00			`.. _commercial-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`
Copy feedback * use commercial instead of business * Custom Domain instead CNAM * paraphrase some sentences * rename alternate_domain.rst to custom_domain.rst 2018-10-03 10:30:55 +00:00			`:caption: Commercial Documentation`
Add basic canonical URL docs 2014-01-03 20:48:04 +00:00
Copy feedback * use commercial instead of business * Custom Domain instead CNAM * paraphrase some sentences * rename alternate_domain.rst to custom_domain.rst 2018-10-03 10:30:55 +00:00			`commercial/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`