The source code that powers readthedocs.org
 
 
 
 
 
 
Go to file
Stein Magnus Jodal dce6a6d524 Pull in new translations from Transifex 2014-01-06 23:26:30 +01:00
.tx added tx config 2012-10-03 13:28:54 +02:00
deploy Add smoke tests for underscore redirects 2014-01-06 12:16:47 -05:00
docs Fix wording 2014-01-06 12:58:07 -05:00
logs Put the logs directory in the repo. 2012-03-12 15:35:28 -07:00
media Update theme 2013-12-21 08:31:34 -05:00
readthedocs Pull in new translations from Transifex 2014-01-06 23:26:30 +01:00
.gitignore Fix cname link 2013-11-25 22:20:45 -08:00
.gitmodules Add new theme 2013-10-17 13:26:19 -07:00
.travis.yml Don't use mirrors 2013-11-06 09:28:33 -08:00
AUTHORS.rst Added self to authors list. 2014-01-05 15:19:50 -08:00
LICENSE.mit Fixed #130. Derp. 2012-01-31 18:43:26 -08:00
README.rst Change status README to use image directive. 2013-10-28 15:13:49 -07:00
deploy_requirements.txt minor cleanup 2013-10-26 20:32:07 -07:00
fabfile-development.py so much flake8 2013-04-07 19:07:56 -07:00
fabfile.py Tail logs after change 2013-11-27 09:11:37 -08:00
manage.py Add top-level manage.py 2013-11-25 21:31:43 -08:00
onebox_requirements.txt Fix redis-cache module path and dependency in onebox 2013-06-02 22:36:07 +09:00
pip_requirements.txt Upgrade to Sphinx 1.2 \o/ 2014-01-06 13:05:55 -05:00
runtests.sh attempt to fix logging 2013-04-22 01:29:12 -07:00
setup.py clean up imports 2013-03-18 20:46:28 -07:00

README.rst

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

.. image:: https://travis-ci.org/rtfd/readthedocs.org.png?branch=master
    :alt: status
    :scale: 100%
    :target: https://travis-ci.org/rtfd/readthedocs.org

`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.

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

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.