The source code that powers readthedocs.org
 
 
 
 
 
 
Go to file
Eric Holscher 9ca5bb13b3 Update the README. Long overdue. 2011-06-29 20:20:13 -07:00
deploy Start a basic readme for the deploy dir. 2011-06-19 19:56:05 -07:00
docs Add talks link. 2011-06-21 10:30:56 -07:00
media Hard code the URL so it works on subdomains/CNAMEs. 2011-06-23 19:28:27 -07:00
readthedocs Derp. 2011-06-28 09:00:56 -07:00
.gitignore Update gitignore. 2011-06-19 14:58:41 -07:00
AUTHORS.rst Update the authors file with more awesome contibutors. 2011-06-29 20:15:57 -07:00
LICENSE.bsd Got caught using the time machine :( 2010-08-17 00:06:40 -05:00
README.rst Update the README. Long overdue. 2011-06-29 20:20:13 -07:00
deploy_requirements.txt Move redis to the normal reqs. 2011-06-24 10:57:38 -07:00
fabfile.py Purge root urls for sites when rebuilding, so default branches change. 2011-06-28 08:53:24 -07:00
pip_requirements.txt Move redis to the normal reqs. 2011-06-24 10:57:38 -07:00
setup.py Added a setup.py since it's a package. 2011-02-16 21:00:13 -08:00

README.rst

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

`Read the Docs`_ hosts documentation for the open source community.It supports Sphinx_ docs written with reStructuredText_, and can pullfrom 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 user
s of readthedocs.org, that is the first section. The next section is for users of the code tha
t powers the site. All of the RTD code is open source, so you can run your own instance. Presu
mably in an internal install inside your company, or something.