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
  • 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
  • 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
  • Developer Documentation
  • Read the Docs website
Read the Docs user documentation
    Learn more about Read the Docs Sign up
    • Index
    • Edit on GitHub

    Index

    C | D | E | F | G | M | P | R | S | U | V | W

    C

    • CI/CD
    • configuration file

    D

    • dashboard
    • default version
    • diff
    • discoverability
    • Docs as Code

    E

    • environment variable
      • READTHEDOCS, [1], [2]
      • READTHEDOCS_CANONICAL_URL
      • READTHEDOCS_GIT_CLONE_URL, [1]
      • READTHEDOCS_GIT_COMMIT_HASH
      • READTHEDOCS_GIT_IDENTIFIER, [1]
      • READTHEDOCS_LANGUAGE
      • READTHEDOCS_OUTPUT
      • READTHEDOCS_PRODUCTION_DOMAIN
      • READTHEDOCS_PROJECT
      • READTHEDOCS_REPOSITORY_PATH, [1]
      • READTHEDOCS_VERSION
      • READTHEDOCS_VERSION_NAME
      • READTHEDOCS_VERSION_TYPE
      • READTHEDOCS_VIRTUALENV_PATH

    F

    • flyout menu

    G

    • GitOps

    M

    • maintainer

    P

    • pinning
    • pre-defined build jobs
    • project home
    • project page
    • Python Enhancement Proposals
      • PEP 287
      • PEP 440

    R

    • READTHEDOCS, [1]
    • READTHEDOCS_GIT_CLONE_URL
    • READTHEDOCS_GIT_IDENTIFIER
    • READTHEDOCS_REPOSITORY_PATH
    • reproducible
    • root URL

    S

    • slug
    • static website
    • subproject

    U

    • user-defined build jobs

    V

    • virtualenv

    W

    • webhook

    © Copyright Read the Docs, Inc & contributors.

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