Product Information
What is Read the docs?
Read The Docs hosts documentation for the open-source community. It supports Sphinx documentation written in reStructuredText and can pull from Subversion, Bazaar, Git, and Mercurial repositories. The code is open-source and can be found on GitHub.
The site's documentation is divided into two distinct sections. The first one is for users of readthedocs.org. The next section is for those utilizing the site's code. All RTD code is open-source, allowing you to run your own instance, likely within your company's internal setup or elsewhere.
How to use Read the docs?
Read the Docs is a documentation building and hosting platform designed to help developers create versioned documentation from code and provide hosting services for open-source communities, enabling team collaboration on documentation.
Core Functions of Read the docs
MarkDown Support
ReStructuredText
Usage Scenarios of Read the docs
- Host documentation for the open-source community.
- Deploy private documentation instances within a company.
- Provide documentation hosting for free and open-source projects.
- Offer documentation hosting for commercial and non-free projects.
- Share documents within a team.
- Preview document updates via pull requests.
Common Questions about Read the docs
What does Read the Docs do?
How do I use Read the Docs?
What are the core features of Read the Docs?
What are the application scenarios of Read the Docs?
