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

put on your copy cap

rtd2
Charles Leifer 2010-08-15 23:01:19 -05:00
parent 4691f939ee
commit d6e263b1ce
2 changed files with 43 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/index.rst
View File

@ -7,8 +7,18 @@ Welcome to Read The Docs's
==========================
This is a site devoted to the hosting of documentation for the open source
community. It currently only supports sphinx docs and git repositories.
However, this will be changed over time to at least support hg.
community. It currently supports sphinx documentation, written in
`reStructuredText format <http://sphinx.pocoo.org/rest.html>`_. We can pull
your existing docs if they're hosted on GitHub or Bitbucket, or you can
create documentation using our reSt editor.
Why readthedocs.org?
--------------------
Our aim is to make it easy for open source developers to host their projects'
documentation!
Contents:

31
docs/install.rst
View File

@ -22,3 +22,34 @@ Installing RTD is pretty simple. Here is a step by step plan on how to do it.
Now you should be seeing a page with the list of projects that you can click around on. I recommend logging in to see more of the sites functionality, and to create or edit more repos.
What's available
----------------
After registering with the site (or creating yourself a superuser account),
you will be able to log in and view the `dashboard <http://readthedocs.org/dashboard/`_
From the dashboard you can either create new documentation, or import your existing
docs provided that they are in a git or mercurial repo.
Creating new Docs
^^^^^^^^^^^^^^^^^
One of the goals of `readthedocs.org <http://readthedocs.org>`_ is to make it
easy for any open source developer to get high quality hosted docs with great
visibility! We provide a simple editor and two sample pages whenever
a new project is created. From there its up to you to fill in the gaps - we'll
build the docs, give you access to history on every revision of your files,
and we plan on adding more features in the weeks and months to come.
Importing existing docs
^^^^^^^^^^^^^^^^^^^^^^^
The other side of `readthedocs.org <http://readthedocs.org>`_ is hosting the
docs you've already built. Simply provide us with the clone url to your repo,
we'll pull your code, extract your docs, and build them! We make available
a post-commit webhook that can be configured to update the docs on our site
whenever you commit to your repo, effectively letting you 'set it and forget it'.