The source code that powers readthedocs.org
 
 
 
 
 
 
Go to file
Eric Holscher 9afc4ea4b3 Fix spacing 2014-03-11 15:29:38 +08:00
.tx added tx config 2012-10-03 13:28:54 +02:00
deploy Use better CNAME in nginx-smoke-test.py. 2014-03-07 22:26:09 -08:00
docs Fix spacing 2014-03-11 15:29:38 +08:00
logs Put the logs directory in the repo. 2012-03-12 15:35:28 -07:00
media Bump theme 2014-03-03 21:29:40 +08:00
readthedocs Add command to generate metadata 2014-03-08 14:26:12 +08:00
.gitignore Add .vagrant to .gitignore. 2014-02-21 13:55:01 -08:00
.gitmodules Add new theme 2013-10-17 13:26:19 -07:00
.travis.yml Fix travis config 2014-02-11 14:41:42 +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
Vagrantfile Change checkout to use vagrant share, add auth fixture 2014-02-09 18:37:12 -08: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 Update doc translations 2014-03-05 10:29:56 +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 typo in pip_requirements bar -> bzr 2014-03-07 15:13:21 -08:00
runtests.sh Fix runtests exit code 2014-01-09 02:17:06 -08: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.