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
    • API v3
    • API v2
    • Server side search API
    • Cross-site requests
  • Frequently asked questions
  • Changelog
  • About Read the Docs
  • Developer Documentation
  • Read the Docs website
Read the Docs user documentation
  • Public REST API
  • Edit on GitHub

Public REST API

This section of the documentation details the public REST API. Useful to get details of projects, builds, versions, and other resources.

  • API v3
    • Authentication and authorization
      • Token
      • Session
      • Rate limiting
      • Pagination
    • Resources
      • Projects
      • Versions
      • Builds
      • Subprojects
      • Translations
      • Redirects
      • Environment variables
      • Organizations
      • Remote organizations
      • Remote repositories
    • Embed
    • Additional APIs
  • API v2
    • Authentication and authorization
    • Resources
      • Projects
      • Versions
      • Builds
      • Embed
      • Undocumented resources and endpoints
  • Server side search API
    • API v3
      • Migrating from API v2
    • Authentication and authorization
    • API v2 (deprecated)
  • Cross-site requests
    • Cookies
Previous Next

© Copyright Read the Docs, Inc & contributors.

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