The source code that powers readthedocs.org
 
 
 
 
 
 
Go to file
Eric Holscher 9dd78a4c83 CLean up conf.py 2013-07-24 17:42:32 -07:00
.tx added tx config 2012-10-03 13:28:54 +02:00
deploy so much flake8 2013-04-07 19:07:56 -07:00
docs CLean up conf.py 2013-07-24 17:42:32 -07:00
logs Put the logs directory in the repo. 2012-03-12 15:35:28 -07:00
media Don't claim the outcome of an unfinished build is 'failed' 2013-03-15 13:20:02 +01:00
readthedocs Move websupport into its own package. 2013-07-24 17:42:32 -07:00
.gitignore Ignore the dash build dir. 2013-04-08 12:41:13 +02:00
.travis.yml run tests on travis-ci 2013-04-11 17:05:13 -07:00
AUTHORS.rst Add mviera to contributors 2013-01-24 10:27:34 -08:00
LICENSE.mit Fixed #130. Derp. 2012-01-31 18:43:26 -08:00
README.rst turning an image into a link is hard 2013-04-21 23:10:07 -07:00
deploy_requirements.txt Fix deploy requirements 2012-11-23 19:51:47 -08:00
fabfile-development.py so much flake8 2013-04-07 19:07:56 -07:00
fabfile.py so much flake8 2013-04-07 19:07:56 -07:00
onebox_requirements.txt Fix redis-cache module path and dependency in onebox 2013-06-02 22:36:07 +09:00
pip_requirements.txt change to django-nose for test running 2013-04-21 22:57:18 -07: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
========================

|status|

.. |status| image:: https://travis-ci.org/rtfd/readthedocs.org.png?branch=master
.. _status: 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.