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.
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
.. toctree:: :maxdepth: 2 :caption: User Documentation versions builds features connected-accounts support faq yaml-config guides/index api/index embed
.. toctree:: :maxdepth: 2 :glob: :caption: Feature Documentation webhooks badges alternate_domains localization vcs subprojects conda canonical single_version privacy user-defined-redirects automatic-redirects features/*
.. 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
.. toctree:: :maxdepth: 1 :caption: Developer Documentation changelog install architecture tests docs development/standards development/buildenvironments symlinks settings i18n issue-labels security design RTD Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>
.. toctree:: :maxdepth: 2 :caption: Business Documentation business/index
.. toctree:: :maxdepth: 2 :caption: Custom Install Documentation custom_installs/index