EbookFoundation
/
readthedocs.org
mirror of https://github.com/EbookFoundation/readthedocs.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update the README. Long overdue.

rtd2
Eric Holscher 2011-06-29 20:20:13 -07:00
parent 0967f72a50
commit 9ca5bb13b3
2 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README
View File

@ -1,5 +0,0 @@
An awesome documentation hosting site.
Installation and usage documentation is available online:
http://read-the-docs.rtfd.org

21
README.rst Normal file
View File

@ -0,0 +1,21 @@
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.