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.
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: With Sphinx | With MkDocs
- Importing your existing documentation: Import guide
User Documentation¶
- Versions
- Build Process
- Read the Docs features
- Connecting Your Account
- Support
- Frequently Asked Questions
- My project isn’t building with autodoc
- How do I change my project slug (the URL your docs are served at)?
- How do I change the version slug of my project?
- Help, my build passed but my documentation page is 404 Not Found!
- How do I change behavior for Read the Docs?
- I get import errors on libraries that depend on C modules
Client Error 401when building documentation- Deleting a stale or broken build environment
- How do I host multiple projects on one custom domain?
- Where do I need to put my docs for RTD to find it?
- I want to use the Blue/Default Sphinx theme
- I want to use the Read the Docs theme locally
- Image scaling doesn’t work in my documentation
- I want comments in my docs
- How do I support multiple languages of documentation?
- Does Read The Docs work well with “legible” docstrings?
- Can I document a python package that is not at the root of my repository?
- What commit of Read the Docs is in production?
- Read the Docs YAML Config
- Guides
- Adding Custom CSS or JavaScript to a Sphinx Project
- Enabling Build Notifications
- My Build is Using Too Many Resources
- Enabling Google Analytics on your Project
- Manage Translations
- Keep Building Docs With Old Version Of MkDocs
- Removing “Edit on …” Buttons from Documentation
- Specifying Dependencies
- Wiping a Build Environment
- Public API
- Embed API
Feature Documentation
About Read the Docs¶
Developer Documentation¶
Commercial Documentation¶
Custom Install Documentation¶