Getting Started with Read the Docs
Build and host beautiful documentation for your projects using Git and Markdown.
Getting Started
Connect a Project
Link your Git repository from GitHub, GitLab, or Bitbucket for automatic builds.
Create a Project →Configure Builds
Enable automatic building from Sphinx, MkDocs, or other documentation generators.
Configure Build →Review and Deploy
Deploy your documentation with one-click publish, or use a custom domain.
Publish Now →Key Features
Versioned Content
Create multiple versions of your documentation for different project releases.
Private Projects
Restrict access with authentication and permission controls for sensitive documentation.
CI/CD Integration
Automate documentation builds with webhooks from Git and CI systems.
Search & Discovery
Full-text search powered by indexing across your entire documentation set.
Integrated Tools
Git Integration
Connect your repository to automate builds with every push, pull request, or tag.
- 1 Link your repo from GitHub, GitLab, or Bitbucket
- 2 Auto-trigger builds on commit
- 3 Preview documentation at each PR
Advanced Configuration
Customize your documentation with themes, subprojects, and API access.
- Custom domains and SEO settings
- Private docs with role-based access
- Build-time plugins and hooks