Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Read the Docs user documentation
Light Logo Dark Logo

Getting started

  • Tutorial
  • Adding a documentation project
  • Popular documentation tools
    • Deploying Sphinx on Read the Docs
    • Deploying MkDocs on Read the Docs
    • Deploying Docusaurus on Read the Docs
    • Deploying Markdoc on Read the Docs
    • Deploying mdBook on Read the Docs
    • Deploying VitePress on Read the Docs
    • Deploying Antora on Read the Docs
    • Deploying Zensical on Read the Docs
    • Deploying MyST Markdown on Read the Docs
  • 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
  • URL path prefixes
  • Documentation notifications
  • Canonical URLs
  • Content Delivery Network (CDN) and caching
  • Sitemap support
  • 404 Not Found pages
  • robots.txt support
  • llms.txt support
  • Markdown for AI agents

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
  • Main content detection
  • AI agent skills
  • Custom script

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
    • Connecting your Read the Docs account to your Git provider
    • Configuring a Git repository manually
    • Managing custom domains
    • Managing subprojects
    • Hiding a version
    • Using a .readthedocs.yaml file in a sub-folder
    • Using custom URL redirects in documentation projects
  • Build process
    • Setup email notifications
    • Setting up outgoing webhooks
    • Configuring pull request builds
    • Using custom environment variables
    • Managing versions automatically
    • Skip builds based on conditions
  • Upgrading and maintaining projects
    • Creating reproducible builds
    • Using Conda as your Python environment
  • Content, themes and SEO
    • Search engine optimization (SEO) for documentation projects
    • Using traffic analytics
    • Using search analytics
    • Enabling offline formats
    • Embedding content from your documentation
    • Managing translations for Sphinx projects
    • Supporting Unicode in Sphinx PDFs
    • Cross-referencing with Sphinx
    • Linking to other projects with Intersphinx
    • Using Jupyter notebooks in Sphinx
    • Migrating from rST to MyST
    • Adding custom CSS or JavaScript to Sphinx documentation
    • Adding "Edit Source" links on your Sphinx theme
  • Security and access
    • Single sign-on (SSO) with GitHub, GitLab, or Bitbucket
    • Single sign-on (SSO) with Google Workspace
    • Single sign-on (SSO) with SAML
    • Managing Read the Docs teams
    • Creating a project from a private repository
    • Using private Git submodules
    • Installing private python packages
    • Manage maintainers
  • Account management
    • Managing your Read the Docs for Business subscription
    • Configuring two-factor authentication
  • Best practice
    • Deprecating content
    • Best practices for linking to your documentation
    • Creating reproducible builds
    • Search engine optimization (SEO) for documentation projects
    • Hiding a version
  • Troubleshooting problems
    • Troubleshooting build errors
    • Troubleshooting slow builds

Reference

  • Public REST API
    • API v3
    • API v2
    • Server side search API
    • Cross-site requests
  • 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
      • `Terms of Service <https://about.readthedocs.com/terms-of-service/>`_
      • DMCA takedown policy
        • 2022-06-07
      • Data Processing Addendum (DPA)
        • Sub-processor list
    • Advertising
      • EthicalAds
      • Advertising details
      • Ad blocking
      • Customizing 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
Back to top
View this page

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.

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.

Next
Abandoned projects policy
Previous
About Read the Docs
Copyright © Read the Docs, Inc & contributors
Made with Sphinx and @pradyunsg's Furo