146 lines
2.9 KiB
ReStructuredText
146 lines
2.9 KiB
ReStructuredText
Read the Docs: Documentation Simplified
|
|
=======================================
|
|
|
|
`Read the Docs`_ simplifies software documentation
|
|
by automating building, versioning, and hosting of your docs for you.
|
|
Think of it as *Continuous Documentation*.
|
|
|
|
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.
|
|
|
|
.. _Read the docs: http://readthedocs.org/
|
|
|
|
|
|
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>`
|
|
|
|
* **Importing your existing documentation**:
|
|
:doc:`Import guide <intro/import-guide>`
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:hidden:
|
|
:caption: First Steps
|
|
|
|
intro/getting-started-with-sphinx
|
|
intro/getting-started-with-mkdocs
|
|
intro/import-guide
|
|
|
|
|
|
.. _user-docs:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: User Documentation
|
|
|
|
versions
|
|
builds
|
|
features
|
|
connected-accounts
|
|
support
|
|
faq
|
|
config-file/index
|
|
guides/index
|
|
api/index
|
|
embed
|
|
|
|
.. _feature-docs:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:glob:
|
|
:caption: Feature Documentation
|
|
|
|
webhooks
|
|
badges
|
|
custom_domains
|
|
localization
|
|
vcs
|
|
subprojects
|
|
conda
|
|
canonical
|
|
single_version
|
|
privacy
|
|
user-defined-redirects
|
|
automatic-redirects
|
|
features/*
|
|
|
|
.. _about-docs:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: About Read the Docs
|
|
|
|
contribute
|
|
roadmap
|
|
team
|
|
gsoc
|
|
code-of-conduct
|
|
privacy-policy
|
|
advertising/index
|
|
sponsors
|
|
open-source-philosophy
|
|
story
|
|
abandoned-projects
|
|
dmca/index
|
|
|
|
.. _dev-docs:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Developer Documentation
|
|
|
|
changelog
|
|
install
|
|
development/search
|
|
architecture
|
|
tests
|
|
docs
|
|
development/standards
|
|
development/buildenvironments
|
|
symlinks
|
|
settings
|
|
i18n
|
|
issue-labels
|
|
security
|
|
design
|
|
RTD Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>
|
|
|
|
.. _commercial-docs:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Commercial Documentation
|
|
|
|
commercial/index
|
|
|
|
.. _custom-docs:
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Custom Install Documentation
|
|
|
|
custom_installs/index
|