Logo

Getting started

  • Tutorial
  • Adding a documentation project
  • Popular documentation tools
  • Example projects

Project setup and configuration

  • Configuration file overview
  • Configuration file reference
  • Read the Docs Addons
  • Account authentication methods
  • Automation rules
  • How to create reproducible builds

Build process

  • Build process overview
  • Build process customization
  • Git integration (GitHub, GitLab, Bitbucket)
  • Pull request previews
  • Build failure notifications
  • Environment variable overview
  • Environment variable reference

Hosting documentation

  • Versions
  • Subprojects
  • Localization and Internationalization
  • URL versioning schemes
  • Custom domains
  • Documentation notifications
  • Canonical URLs
  • Content Delivery Network (CDN) and caching
  • Sitemap support
  • 404 Not Found pages
  • robots.txt support

Reading documentation

  • Offline formats (PDF, ePub, HTML)
  • Visual diff
  • Link previews
  • How to embed content from your documentation
  • Server side search
  • Search query syntax
  • Flyout menu

Maintaining projects

  • Redirects
  • Traffic analytics
  • Search analytics
  • Security logs
  • Status badges
  • How to structure your documentation
  • Best practices for linking to your documentation
  • Security considerations for documentation pages

Business features

  • Business hosting
  • Organizations
  • Single Sign-On (SSO)
  • Sharing private documentation
  • How to manage your subscription
  • Privacy levels

How-to guides

  • Project setup and configuration
  • Build process
  • Upgrading and maintaining projects
  • Content, themes and SEO
  • Security and access
  • Account management
  • Best practice
  • Troubleshooting problems

Reference

  • Public REST API
  • Frequently asked questions
  • Changelog
  • About Read the Docs
    • Policies and legal documents
      • Abandoned projects policy
      • Unofficial and unmaintained projects policy
      • Privacy Policy
      • Security policy
      • Security reports
      • Read the Docs Terms of Service
      • DMCA takedown policy
      • Data Processing Addendum (DPA)
    • Advertising
    • The story of Read the Docs
    • Sponsors of Read the Docs
    • Documentation in scientific and academic publishing
    • Read the Docs open source philosophy
    • Read the Docs team
    • Site support
    • Glossary
  • Developer Documentation
  • Read the Docs website
Read the Docs user documentation
  • About Read the Docs
  • Policies and legal documents
  • Edit on GitHub

Policies and legal documents

Here is some of the fine print used by Read the Docs Community and Read the Docs for Business:

Abandoned projects policy

Our policy of taking action on abandoned projects.

Unofficial and unmaintained projects policy

Our policy of taking action on unofficial and unmaintained projects.

Read the Docs Terms of Service

The terms of service for using Read the Docs Community and Read the Docs for Business. You may instead have a master services agreement for your subscription if you have a custom or enterprise contract.

Privacy Policy

Our policy on collecting, storing, and protecting user and visitor data.

Security policy

Our policies around application and infrastructure security.

Security reports

How we respond to security incidents and how you report a security issue.

Data Processing Addendum (DPA)

For GDPR and CCPA compliance, we provide a data processing addendum for Read the Docs for Business customers.

DMCA takedown policy

Our process for taking down content based on DMCA requests and how to submit requests.

Previous Next

© Copyright Read the Docs, Inc & contributors.

Built with Sphinx using a theme provided by Read the Docs.