Logo

🚀 Tutorials

  • Read the Docs tutorial
  • Getting started with Sphinx
  • Getting started with MkDocs
  • Importing your documentation
  • Example projects

💡 Explanation

  • Choosing between our two platforms
  • Continuous Documentation Deployment
  • Understanding offline formats
  • Understanding environment variables
  • Subprojects: host multiple projects on a single domain
  • Localization of documentation

🪄 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

  • Feature reference
  • Configuration file
  • Build process overview
  • Build process customization
  • Search query syntax
  • Frequently asked questions
  • Public API
    • API v3
    • API v2
    • Server side search API
    • Cross-site requests
  • Changelog
  • About Read the Docs
  • Developer Documentation
Read the Docs user documentation
  • Public API
  • Edit on GitHub

Public API

This section of the documentation details the public API usable to get details of projects, builds, versions and other details from Read the Docs.

  • API v3
    • Authentication and authorization
      • Token
      • Session
    • 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. Revision c36fc573.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: stable
Versions
latest
stable
diataxis-main
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds