2018-09-28 22:42:50 +00:00
|
|
|
Read the Docs: Documentation Simplified
|
|
|
|
=======================================
|
2010-08-14 05:07:13 +00:00
|
|
|
|
2018-09-28 22:42:50 +00:00
|
|
|
`Read the Docs`_ simplifies software documentation
|
|
|
|
by automating building, versioning, and hosting of your docs for you.
|
2014-10-14 19:16:03 +00:00
|
|
|
Think of it as *Continuous Documentation*.
|
|
|
|
|
2018-09-28 22:42:50 +00:00
|
|
|
Never out of sync
|
|
|
|
Whenever you push code to your favorite version control system,
|
|
|
|
whether that is Git, Mercurial, Bazaar, or Subversion,
|
|
|
|
Read the Docs will automatically build your docs
|
|
|
|
so your code and documentation are always up-to-date.
|
|
|
|
|
|
|
|
Multiple versions
|
|
|
|
Read the Docs can host and build multiple versions of your docs
|
|
|
|
so having a 1.0 version of your docs and a 2.0 version
|
|
|
|
of your docs is as easy as having a separate branch or tag in your version control system.
|
|
|
|
|
|
|
|
Free and open source
|
|
|
|
Read the Docs is free and open source and hosts documentation
|
|
|
|
for nearly 100,000 large and small open source projects
|
|
|
|
in almost every human and computer language.
|
2010-09-08 00:20:43 +00:00
|
|
|
|
2011-01-11 03:09:03 +00:00
|
|
|
.. _Read the docs: http://readthedocs.org/
|
2010-08-16 04:01:19 +00:00
|
|
|
|
2014-01-18 14:10:25 +00:00
|
|
|
|
2018-09-28 22:42:50 +00:00
|
|
|
First steps
|
|
|
|
-----------
|
|
|
|
|
|
|
|
Are you new to software documentation
|
|
|
|
or are you looking to use your existing docs with Read the Docs?
|
|
|
|
Learn about documentation authoring tools such as Sphinx and MkDocs
|
|
|
|
to help you create fantastic documentation for your project.
|
|
|
|
|
|
|
|
* **Getting started**:
|
|
|
|
:doc:`With Sphinx <intro/getting-started-with-sphinx>` |
|
|
|
|
:doc:`With MkDocs <intro/getting-started-with-mkdocs>`
|
2014-01-18 14:33:50 +00:00
|
|
|
|
2018-09-28 22:42:50 +00:00
|
|
|
* **Importing your existing documentation**:
|
|
|
|
:doc:`Import guide <intro/import-guide>`
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
|
|
|
:hidden:
|
|
|
|
:caption: First Steps
|
2014-01-18 14:33:50 +00:00
|
|
|
|
2018-09-28 22:42:50 +00:00
|
|
|
intro/getting-started-with-sphinx
|
|
|
|
intro/getting-started-with-mkdocs
|
|
|
|
intro/import-guide
|
2014-04-14 14:19:41 +00:00
|
|
|
|
2011-04-10 01:45:04 +00:00
|
|
|
|
2015-05-04 22:00:39 +00:00
|
|
|
.. _user-docs:
|
2011-04-02 22:04:03 +00:00
|
|
|
|
2010-08-14 05:07:13 +00:00
|
|
|
.. toctree::
|
2015-05-04 22:00:39 +00:00
|
|
|
:maxdepth: 2
|
|
|
|
:caption: User Documentation
|
2010-09-03 02:27:25 +00:00
|
|
|
|
2015-05-04 22:00:39 +00:00
|
|
|
versions
|
|
|
|
builds
|
|
|
|
features
|
2018-09-28 22:42:50 +00:00
|
|
|
connected-accounts
|
2015-05-04 22:00:39 +00:00
|
|
|
support
|
|
|
|
faq
|
2018-07-30 20:15:53 +00:00
|
|
|
config-file/index
|
2016-04-28 17:37:46 +00:00
|
|
|
guides/index
|
2018-06-19 21:56:24 +00:00
|
|
|
api/index
|
2017-01-05 19:41:29 +00:00
|
|
|
embed
|
2014-01-18 14:10:25 +00:00
|
|
|
|
2015-05-04 22:00:39 +00:00
|
|
|
.. _feature-docs:
|
2014-01-18 14:10:25 +00:00
|
|
|
|
|
|
|
.. toctree::
|
2015-05-04 22:00:39 +00:00
|
|
|
:maxdepth: 2
|
|
|
|
:glob:
|
|
|
|
:caption: Feature Documentation
|
|
|
|
|
|
|
|
webhooks
|
|
|
|
badges
|
|
|
|
alternate_domains
|
|
|
|
localization
|
|
|
|
vcs
|
2017-01-31 22:18:19 +00:00
|
|
|
subprojects
|
2015-11-30 22:37:12 +00:00
|
|
|
conda
|
2015-05-04 22:00:39 +00:00
|
|
|
canonical
|
|
|
|
single_version
|
|
|
|
privacy
|
|
|
|
user-defined-redirects
|
|
|
|
automatic-redirects
|
|
|
|
features/*
|
2012-12-10 18:57:33 +00:00
|
|
|
|
2018-09-28 22:42:50 +00:00
|
|
|
.. _about-docs:
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 1
|
|
|
|
:caption: About Read the Docs
|
|
|
|
|
|
|
|
contribute
|
2018-10-02 23:41:14 +00:00
|
|
|
roadmap
|
2018-09-28 22:42:50 +00:00
|
|
|
team
|
|
|
|
gsoc
|
|
|
|
code-of-conduct
|
|
|
|
privacy-policy
|
|
|
|
advertising/index
|
|
|
|
sponsors
|
|
|
|
open-source-philosophy
|
|
|
|
story
|
|
|
|
abandoned-projects
|
|
|
|
dmca/index
|
2014-11-05 21:44:51 +00:00
|
|
|
|
2015-05-04 22:00:39 +00:00
|
|
|
.. _dev-docs:
|
2014-11-05 21:44:51 +00:00
|
|
|
|
|
|
|
.. toctree::
|
2018-09-28 22:42:50 +00:00
|
|
|
:maxdepth: 1
|
2015-05-04 22:00:39 +00:00
|
|
|
:caption: Developer Documentation
|
|
|
|
|
2015-07-23 18:31:18 +00:00
|
|
|
changelog
|
2017-11-10 12:52:11 +00:00
|
|
|
install
|
2018-12-20 14:25:26 +00:00
|
|
|
development/search
|
2017-11-10 12:52:11 +00:00
|
|
|
architecture
|
2015-05-04 22:00:39 +00:00
|
|
|
tests
|
2016-11-30 22:35:38 +00:00
|
|
|
docs
|
2015-08-08 00:13:17 +00:00
|
|
|
development/standards
|
|
|
|
development/buildenvironments
|
2015-05-04 22:00:39 +00:00
|
|
|
symlinks
|
|
|
|
settings
|
|
|
|
i18n
|
2015-07-24 10:31:39 +00:00
|
|
|
issue-labels
|
2018-02-19 23:46:24 +00:00
|
|
|
security
|
2018-09-28 22:42:50 +00:00
|
|
|
design
|
|
|
|
RTD Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>
|
2014-11-05 21:44:51 +00:00
|
|
|
|
2018-10-03 10:30:55 +00:00
|
|
|
.. _commercial-docs:
|
2014-11-05 21:44:51 +00:00
|
|
|
|
2015-05-04 22:00:39 +00:00
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
2018-10-03 10:30:55 +00:00
|
|
|
:caption: Commercial Documentation
|
2014-01-03 20:48:04 +00:00
|
|
|
|
2018-10-03 10:30:55 +00:00
|
|
|
commercial/index
|
2014-01-18 14:33:50 +00:00
|
|
|
|
2015-06-01 15:54:04 +00:00
|
|
|
.. _custom-docs:
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
:maxdepth: 2
|
|
|
|
:caption: Custom Install Documentation
|
|
|
|
|
|
|
|
custom_installs/index
|