2011-06-30 03:20:13 +00:00
|
|
|
Welcome to Read The Docs
|
|
|
|
|
========================
|
|
|
|
|
|
2013-10-28 22:13:49 +00:00
|
|
|
.. image:: https://travis-ci.org/rtfd/readthedocs.org.png?branch=master
|
|
|
|
|
:alt: status
|
|
|
|
|
:scale: 100%
|
|
|
|
|
:target: https://travis-ci.org/rtfd/readthedocs.org
|
2013-04-22 06:08:30 +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.
|
2011-06-30 03:20:13 +00:00
|
|
|
|
|
|
|
|
The full documentation is available on `the site`_.
|
|
|
|
|
|
|
|
|
|
.. _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/
|
|
|
|
|
.. _the site: http://read-the-docs.readthedocs.org
|
|
|
|
|
|
2013-04-22 06:08:30 +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.
|
