74 lines
1.6 KiB
ReStructuredText
74 lines
1.6 KiB
ReStructuredText
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 code is open source, and `available on github`_.
|
|
|
|
.. _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/
|
|
.. _available on github: http://github.com/rtfd/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.
|
|
|
|
|
|
Site Documentation
|
|
------------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
getting_started
|
|
faq
|
|
support
|
|
features
|
|
theme
|
|
privacy
|
|
webhooks
|
|
alternate_domains
|
|
sponsors
|
|
builds
|
|
talks
|
|
|
|
Designer Documentation
|
|
----------------------
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
design
|
|
|
|
Developer Documentation
|
|
-----------------------
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
install
|
|
todo
|
|
contribute
|
|
architecture
|
|
settings
|
|
tests
|
|
i18n
|
|
api
|
|
api/index
|
|
|
|
Custom install Documentation
|
|
----------------------------
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
custom_installs/index
|
|
|
|
Operations Documentation
|
|
------------------------
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
rtfd
|