+ + Documentation simplified +
++ Build, host, and share documentation, all with a single platform. +
+ + + Sign up now + +
+ + Easy previews and deploys +
++ Preview changes on every commit to your pull requests. + Release documentation to your users on each merge. +
++ Ideal developer experience +
++ Write documentation without changing your workflow or your tools + using a docs as code approach. +
++ Work privately or publicly +
++ Easily share within your team or with the whole world. + Manage permissions yourself or automatically with GitHub. +
++ Features +
++ Supports any doc tool +
++ Integrated support for Sphinx, MkDocs, Jupyter Book. + Flexible enough to work with any documentation tool. +
++ Integrated search +
++ Easily search all your docs via our dashboard, + and offer your users a more powerful search with our search API. +
++ Pull request previews +
++ Preview each pull request before releasing any changes, + allowing for fast collaboration across your organization. +
++ Versioned docs +
++ Match your product release cycle with multiple versions of your docs. Automatically build versions from any branch or tag. +
++ Private repository support + + + Paid plan feature + +
++ Clone private repositories using a connected GitHub, GitLab, or Bitbucket account, + or clone from any Git provider with an SSH key. +
++ Single-Sign On + + + Paid plan feature + +
++ Control who has access to your documentation with integrated authentication. + Enable SSO with GitHub or GitLab to easily manage permissions in one place. +
++ Upgrade your documentation with Read the Docs +
+ +.readthedocs.yaml
+ version: 2
+build:
+ os: ubuntu-22.04
+ tools:
+ python: "3.10"
+ # You can also specify other tool versions:
+ # nodejs: "16"
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+ configuration: docs/conf.py
+# Dependencies required to build your docs
+python:
+ install:
+ - requirements: docs/requirements.txt
++ + + Join thousands of happy users + +
+
+
+
+ + Get your docs online in 5 minutes. +
+ +