The source code that powers readthedocs.org
 
 
 
 
 
 
Go to file
Eric Holscher 2b1386b78c Update ops docs. 2012-09-27 14:08:55 -07:00
deploy Fix CNAME index.html issue. >:x@regex 2012-08-31 12:37:51 -07:00
docs Update ops docs. 2012-09-27 14:08:55 -07:00
logs Put the logs directory in the repo. 2012-03-12 15:35:28 -07:00
media Made badge small until hovered. 2012-09-07 12:44:12 -04:00
readthedocs Don't execfile for now, it causes errors to bubble. 2012-09-26 23:17:30 -07:00
.gitignore Add logs directory for storing all logs; update settings respectively 2012-03-12 14:11:04 -07:00
AUTHORS.rst Fixed spelling error (fixes #237) 2012-09-07 12:58:35 -03:00
LICENSE.mit Fixed #130. Derp. 2012-01-31 18:43:26 -08:00
README.rst Spacing fixes from copy pasta. 2011-06-29 20:22:47 -07:00
deploy_requirements.txt Added pillow to the deploy requirements for resizing images. 2012-02-23 20:24:01 -08:00
fabfile-development.py Add fabfile to install readthedocs for development. 2012-02-18 15:08:34 -08:00
fabfile.py Fix template name and fabfile. 2012-04-13 11:27:27 -07:00
pip_requirements.txt Fix slumber req. 2012-09-27 08:24:01 -07:00
runtests.sh Add a runtests.sh to the top-level. 2011-09-09 20:41:12 -07:00
setup.py Stub out requirements. 2011-09-09 13:24:48 -07: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 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.